diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..90e05c4 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "github-actions" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" diff --git a/README.md b/README.md new file mode 100644 index 0000000..91af045 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# branch-follow-tag + +## Use case + +Keep a branch always referencing to the most recent tag. + +## Inputs + +| Input | Description | +| ----------- | ----------- | +| GITHUB_TOKEN | Automatically provided token, that can be used to authenticate on behalf of the GitHub action, with permissions limited to the repository that contains your workflow | +| SSH_PRIVATE_KEY | Deploy key for push. Must be set in the repository settings. This is used by the action to push the fast-forwarded branch/commit/PR. | +| BRANCH | Name of the branch. | + +## Workflow YML + +The Action must be run `on:push:tags` triggers to keep the labels up-to-date and run the fast-forward on command. + +```yml +name: Fast-Forward + +on: + push: + tags: + +jobs: + run: + runs-on: ubuntu-latest + steps: + - uses: APN-Pucky/branch-follow-tag@main + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SSH_PRIVATE_KEY: ${{ secrets.GH_SSH }} + branch: stable +``` + +## Examples + +* https://github.com/APN-Pucky/smpl_util