[codex] add generated release notes docs#2
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds project-level documentation for licensing, contributing, changelog guidance, and configures release-note generation for per-binary releases.
Changes:
- Adds MIT license, contributing guide, and changelog entrypoint.
- Links project docs from the README and documents generated release notes.
- Updates the release workflow and adds
.github/release.ymlrelease-note categories.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
README.md |
Adds project documentation links and release-note behavior notes. |
LICENSE |
Adds MIT license text. |
CONTRIBUTING.md |
Adds development, release, and licensing contribution guidance. |
CHANGELOG.md |
Adds release-notes entrypoint and initial release link. |
.github/workflows/release.yml |
Resolves per-tool previous tags and publishes generated release notes. |
.github/release.yml |
Defines generated release-note categories and exclusions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| body: | | ||
| Automated release for `${{ steps.release-target.outputs.tool }}` `${{ steps.release-target.outputs.version }}`. | ||
| generate_release_notes: true | ||
| previous_tag: ${{ steps.release-target.outputs.previous_tag }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
Test Plan
make testmake buildgit diff --cached --checkruby -e 'require "yaml"; YAML.load_file(".github/workflows/release.yml"); YAML.load_file(".github/release.yml"); puts "yaml ok"'slack-post-v0.1.1tag range locally and verified it resolvesprevious_tag=slack-post-v0.1.0.Note:
actionlintis not installed locally, so workflow linting was not run.