Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document steps to create a release #10

Merged
merged 3 commits into from
Dec 26, 2022
Merged

Document steps to create a release #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4d7807
chore: better description
timorthi Dec 26, 2022
b18cb47
docs: add release instructions
timorthi Dec 26, 2022
a3bcadd
chore: add branding
timorthi Dec 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,12 @@ This will force the workflow to build the image (and therefore the Go source cod

### Building & Releasing

TODO
See [release management for actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions) and [managing releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#about-release-management) for more info.

1. The `ci` workflow will automatically build and push to GHCR on each merge to `main`.
2. Find the [desired image tag](https://github.com/timorthi/export-workflow-logs/pkgs/container/export-workflow-logs) to pin to this release.
3. Create a release branch and update `action.yml` to point to this image tag.
4. Test pertinent changes in a GitHub Actions workflow by pointing to the release branch and merge if it looks good.
5. Delete the major tag `git tag --delete v1 && git push --delete origin v1`
6. Create the new tag for this release `git tag v1 && git tag v1.1.0 && git push origin --tags`
7. Create a release
6 changes: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
name: "Export Workflow Run Logs"
description: "Uses the GitHub API to download workflow logs and upload them to the target destination."
description: "An action to automatically export GitHub Actions Workflow run logs to Amazon S3."

branding:
icon: "save"
color: "gray-dark"

inputs:
repo-token:
Expand Down