├── .github
    ├── dependabot.yml
    └── workflows
    │   └── release.yml
├── .gitignore
├── LICENSE
├── README.md
└── action.yml


/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 |   - package-ecosystem: "github-actions"
4 |     directory: "/"
5 |     schedule:
6 |       interval: "monthly"
7 | 


--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
 1 | # Releases are fully automated using [semantic-release](https://github.com/semantic-release/semantic-release/).
 2 | #
 3 | # The following commit message conventions determine which version is released:
 4 | #
 5 | # 1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4`
 6 | # 2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0`
 7 | # 3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0`
 8 | #
 9 | # Only one version number is bumped at a time, the highest version change trumps the others.
10 | # Besides, publishing a new version to npm, semantic-release also creates a git tag and release
11 | # on GitHub, generates changelogs from the commit messages and puts them into the release notes.
12 | #
13 | # If the pull request looks good but does not follow the commit conventions, update the pull request title and use the <kbd>Squash & merge</kbd> button, at which point you can set a custom commit message.
14 | #
15 | # With each new release, a breaking version tag (e.g. `v1`, `v2`, etc) is created or updated.
16 | #
17 | # ## Rollback Latest Release
18 | #
19 | # Let's say `v1.2.3` include a bug and we want to roll back to `v1.2.2`. To accomplish that, the `v1` tag needs to be updated. That can be done using the following code
20 | #
21 | # ```
22 | # # update `v1` tag to point to `v1.2.2`
23 | # git tag --force v1 v1.2.2
24 | # git push --force --tags
25 | # ```
26 | #
27 | # Any questions? Ping @gr2m
28 | 
29 | name: 🚀 Release
30 | "on":
31 |   workflow_dispatch:
32 |   push:
33 |     branches:
34 |       - main
35 |       - beta
36 |       - "*.x"
37 | 
38 | jobs:
39 |   release:
40 |     name: release
41 |     runs-on: ubuntu-latest
42 |     steps:
43 |       - uses: actions/checkout@v4
44 |       - uses: actions/setup-node@v4
45 |         with:
46 |           node-version: "lts/*"
47 |       - name: install semantic-release plugins
48 |         run: npm install --no-save semantic-release-plugin-github-breaking-version-tag
49 |       - name: write configuration
50 |         run: |
51 |           cat >.releaserc <<EOL
52 |           {
53 |             "branches": [
54 |               "+([0-9]).x",
55 |               "main",
56 |               {
57 |                 "name": "beta",
58 |                 "prerelease": true
59 |               }
60 |             ],
61 |             "plugins": [
62 |               "@semantic-release/commit-analyzer",
63 |               "@semantic-release/release-notes-generator",
64 |               "semantic-release-plugin-github-breaking-version-tag",
65 |               "@semantic-release/github"
66 |             ]
67 |           }
68 |           EOL
69 |       - name: Release the new version
70 |         run: npx semantic-release --debug
71 |         env:
72 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
73 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Compiled source #
 2 | ###################
 3 | *.com
 4 | *.class
 5 | *.dll
 6 | *.exe
 7 | *.o
 8 | *.so
 9 | 
10 | # Packages #
11 | ############
12 | # it's better to unpack these files and commit the raw source
13 | # git has its own built in compression methods
14 | *.7z
15 | *.dmg
16 | *.gz
17 | *.iso
18 | *.jar
19 | *.rar
20 | *.tar
21 | *.zip
22 | 
23 | # Logs and databases #
24 | ######################
25 | *.log
26 | *.sql
27 | *.sqlite
28 | 
29 | # OS generated files #
30 | ######################
31 | .DS_Store
32 | .DS_Store?
33 | ._*
34 | .Spotlight-V100
35 | .Trashes
36 | ehthumbs.db
37 | Thumbs.db
38 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) GitHub, Inc.
2 | 
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4 | 
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6 | 
7 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Action: Update Step
 2 | 
 3 | Action step: Update the course repository when the learner completes a step.
 4 | 
 5 | _This is not a course._ Visit https://github.com/skills to view our courses.
 6 | 
 7 | ### Example use
 8 | 
 9 | ```yml
10 | name: Step 0, Welcome
11 | on: push
12 | permissions:
13 |   contents: write
14 | jobs:
15 |   on_start:
16 |     name: On start
17 |     runs-on: ubuntu-latest
18 |     steps:
19 |       - name: Checkout
20 |         uses: actions/checkout@v4
21 |         with:
22 |           fetch-depth: 0 # Let's get all the branches.
23 |       - name: Update to step 1
24 |         uses: skills/action-update-step@v2
25 |         with:
26 |           token: ${{ secrets.GITHUB_TOKEN }}
27 |           from_step: 0
28 |           to_step: 1
29 |           branch_name: my-first-branch
30 |           base_branch_name: my-base-branch # Optional
31 | ```
32 | 
33 | &copy; 2024 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
34 | 


--------------------------------------------------------------------------------
/action.yml:
--------------------------------------------------------------------------------
 1 | name: "Update step"
 2 | description: "Update the course repository when the learner completes a step."
 3 | inputs:
 4 |   token:
 5 |     description: "Set to [secrets.GITHUB_TOKEN]."
 6 |     required: true
 7 |   from_step:
 8 |     description: "Requires the -step.txt file set to FROM_STEP."
 9 |     required: true
10 |   to_step:
11 |     description: "The step number to go to next."
12 |     required: true
13 |   branch_name:
14 |     description: "If the learner is working in a branch, add the branch name."
15 |   base_branch_name:
16 |     description: "Optional base branch name (default: main)."
17 |     required: false
18 |     default: "main"
19 | runs:
20 |   using: composite
21 |   steps:
22 |     - shell: bash
23 |       env:
24 |         GITHUB_TOKEN: ${{ inputs.token }}
25 |         FROM_STEP: ${{ inputs.from_step }}
26 |         TO_STEP: ${{ inputs.to_step }}
27 |         BRANCH_NAME: ${{ inputs.branch_name }}
28 |         BASE_BRANCH_NAME: ${{ inputs.base_branch_name }}
29 |       run: |
30 |         echo "Check that all required env variables are set"
31 |         if [ -z "$TO_STEP" ]
32 |         then
33 |           echo "TO_STEP is unset or set to the empty string"
34 |           exit 1
35 |         fi
36 |         if [ -z "$FROM_STEP" ]
37 |         then
38 |           echo "FROM_STEP is unset or set to the empty string"
39 |           exit 1
40 |         fi
41 |         if [ -z "$GITHUB_TOKEN" ]
42 |         then
43 |           echo "GITHUB_TOKEN is unset or set to the empty string"
44 |           exit 1
45 |         fi
46 | 
47 |         echo "Make sure we are on the base branch ($BASE_BRANCH_NAME)"
48 |         git checkout $BASE_BRANCH_NAME
49 | 
50 |         echo "Check that we are on FROM_STEP"
51 |         if [ "$(cat .github/steps/-step.txt)" != $FROM_STEP ]
52 |         then
53 |           echo "Current step is not $FROM_STEP"
54 |           exit 0
55 |         fi
56 | 
57 |         echo "Update the step to TO_STEP"
58 |         NEXT_STEP=$(cat .github/steps/[$TO_STEP]-*.md)
59 |         HEADER=$(awk '/<header>/,/<\/header>/' README.md)
60 |         FOOTER=$(awk '/<footer>/,/<\/footer>/' README.md)
61 |         echo -e "$HEADER\n\n$NEXT_STEP\n\n$FOOTER" > README.md
62 | 
63 |         echo "Update step file to TO_STEP"
64 |         echo "$TO_STEP" > .github/steps/-step.txt
65 | 
66 |         echo "Commit the files, and push to base branch"
67 |         git config user.name github-actions[bot]
68 |         git config user.email github-actions[bot]@users.noreply.github.com
69 |         git add README.md
70 |         git add .github/steps/-step.txt
71 |         git commit --message="Update to $TO_STEP in STEP and README.md"
72 |         git push
73 | 
74 |         echo "If BRANCH_NAME, update that branch as well"
75 |         if git show-ref --quiet refs/heads/$BRANCH_NAME
76 |         then
77 |           git checkout $BRANCH_NAME
78 |           git cherry-pick $BASE_BRANCH_NAME
79 |           git push
80 |         else
81 |           echo "Branch $BRANCH_NAME does not exist"
82 |         fi
83 | 


--------------------------------------------------------------------------------