GitHub Core Repository

GitHub Core Repository Files

README.mdCHANGELOG.mdLICENSE.md

Below is the Github Core Repository Readme

GitHub Actions Collection

A collection of reusable GitHub Actions workflows for standardizing development processes across repositories.

Available Workflows

Release Management

Two workflows that work together to manage the release process:

1. Prepare Release Branch (`prep-release.yml`)

Creates a release branch and prepares the changelog for release.

Trigger:
Push a tag with prefix prep-v (e.g., prep-v1.0.0)

Actions:

Creates a release branch
Moves Unreleased changelog items to a new version section
Removes the Unreleased section for release
Creates a PR for review

Usage:

git tag prep-v1.0.0
git push origin prep-v1.0.0

2. Update Changelog (`update-changelog.yml`)

Automatically updates the changelog when PRs are merged to develop.

Trigger:
PR merged to develop branch

Actions:

Adds PR to Unreleased section of changelog
Creates Unreleased section if it doesn't exist
Maintains changelog formatting

Usage: Automatic - no manual steps required. PR merges to develop trigger the workflow.

Changelog Format

The workflows maintain the following changelog format:

# Repository Changelog
*Note: the changes in this log are automatically generated and commited via github actions, modify only if you know what you are doing!*

## **MM/DD/YYYY - Unreleased**
- PR #{number}: {title}

## **[(MM/DD/YYYY) - {version}](https://github.com/{org}/{repo}/releases/tag/{version})**
- PR #{number}: {title}

Setup Instructions

Copy the desired workflow files to your repository's .github/workflows/ directory
No additional configuration needed - workflows use repository context for variables

Requirements

GitHub repository with develop branch
Permissions to push tags and create PRs
Changelog.md file in repository root (will be created if missing)

Contributing

Create a feature branch off develop
Make your changes
Create a PR to develop
Changelog will be automatically updated upon merge

Support

For issues, questions, or contributions:

Open an issue in this repository
Include workflow name and description of need

License

MIT License - See LICENSE.md file for details

Below is the Github Core Repository Changelog

github.actions Repository Changelog

Note: the changes in this log are automatically generated and commited via github actions, modify only if you know what you are doing!

(01/07/2025) - v1.0.138

What's Changed

Version Updater @mattbuske (#126)
Version Calculator @mattbuske (#125)

Full Changelog: v1.0.122...v1.0.138

(01/06/2025) - v1.0.122

What's Changed

Version Update Action Addition @mattbuske (#120)
Fixed Update Version Name @mattbuske (#119)
Version Update Action @mattbuske (#118)

Full Changelog: v1.0.104...v1.0.117

(01/06/2025) - v1.0.104

What's Changed

Further Workflow Updates @mattbuske (#115)
Further Workflow Updates @mattbuske (#110)
Workflow Enhancements @mattbuske (#101)
Testing Updates @mattbuske (#100)

Full Changelog: v1.0.97...v1.0.104

(01/05/2025) - v1.0.97

Change to Pre-release Mode @mattbuske (#99)

(12/25/2024) - v1.0.0

Reduce Changelog
PR #19: Updated release drafter workflow
PR #18: Added gitignore File
PR #16: Update Changelog
PR #15: Updated Changelog github action

Below is the Github Core Repository License

The MIT License (MIT)

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.

GitHub Core Repository