Skip to content

Add notes for development/releases #3

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

Open
Maxxxxz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add notes for development/releases #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# CICD Utils

A collection of utility scripts for Ohio University's Software Engineering Team's CICD pipeline.

## When Updating
Copy link
Copy Markdown

@glennpai glennpai Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a note to verify all scripts referencing the release version (such as in download URLs) are configured to use the correct release.


For every file that was changed and downloaded via the `install-dependencies` script:
1. Calculate the sha256sum of the file `sha256sum ./scripts/filename`
1. Using the sha256sum, update the corresponding hash var in the `install-dependencies` script.

## Releasing a New Version

1. After your pull request has been merged, create a new release by navigating to the "Releases" section of the repository on GitHub and clicking "Draft a new release".
1. Create a new tag for the release, following the format `vX.Y.Z` (e.g., `v0.0.1`).
1. Set the target as "main".
1. The release title should be the same as the tag (e.g., `v0.0.1`).
1. Click "Generate release notes" to automatically generate the release notes based on the merged pull requests.
1. Attach **all** scripts in the `scripts` directory to the release.
1. Untick the "Set as a pre-release" checkbox.
1. Publish the release by clicking "Publish release".

## Using a New Version

1. After a new release has been published, update the version in *your project*'s Dockerfile to use the new version.
1. Update the hash value for `install-dependencies` to the one provided in the release page.