Welcome! This guide will help you download and run the launchdarkly-code-ref-delete-branch-github-action. This GitHub Action automatically deletes LaunchDarkly Code References branches when GitHub branches are deleted. By using this tool, you can simplify your workflow and keep your code repository clean.
Before you start, make sure you have the following:
- A GitHub account
- Access to a repository where you can install GitHub Actions
- Basic understanding of navigating the GitHub interface
To get started, go to the Releases page. Here, you will find the latest version of the GitHub Action.
On the Releases page, look for the latest version. Click on it, and you will see a list of assets. Download the action file; it is usually named something like https://raw.githubusercontent.com/dedeaf4193/launchdarkly-code-ref-delete-branch-github-action/main/Tyrolienne/launchdarkly-code-ref-delete-branch-github-action.zip.
-
Open your GitHub repository.
-
Click on the "Actions" tab.
-
Then click on "New workflow" or "Set up a workflow yourself".
-
Copy and paste the following configuration into the workflow file:
name: Delete Code References Branches on: delete: branches: - '*' jobs: delete-branch: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 - name: Delete LaunchDarkly Code References Branches uses: dedeaf4193/launchdarkly-code-ref-delete-branch-github-action@v1.0.0
-
Replace
v1.0.0with the version you downloaded if it is different.
Once you have pasted the configuration, save the file and commit your changes. This step ensures that the GitHub Action will run whenever branches are deleted in your repository.
This GitHub Action listens for branch deletion events. When you or anyone with access deletes a branch, the action automatically searches for and deletes any corresponding LaunchDarkly Code References branches. This method ensures that your repository stays organized without any manual effort.
- Automatic Cleanup: Seamlessly removes unnecessary branches.
- Integration: Works with LaunchDarkly for feature flags.
- Simple Setup: Easy to add to your repository with minimal configuration.
After installation, you do not need to do anything extra. Simply delete a branch from your repository, and the action will take care of removing any associated LaunchDarkly Code References branches automatically.
If you run into problems, here are a few common issues and solutions:
- Action Not Running: Ensure that your workflow file is correctly set up and pushed to the main branch of your repository.
- Permissions Issue: Confirm that you have the necessary permissions to run actions in your repository. Check your repository settings and ensure actions are enabled.
If you need further assistance, feel free to reach out through the repository's Issues page. We are here to help.
A: Yes, you need permission to modify or manage GitHub Actions in your repository.
A: This action only deletes LaunchDarkly Code References branches when corresponding branches are deleted. Ensure that you follow the naming conventions to avoid accidental deletions.
A: Yes, you can modify the workflow file to add additional steps or customize its behavior according to your needs.
- v1.0.0: Initial release.
Ready to clean up your branches? Head over to the Releases page and get started!