Skip to content

Commit 9baee40

Browse files
Follow the bake-modernize README template.
1 parent 3100f64 commit 9baee40

1 file changed

Lines changed: 31 additions & 10 deletions

File tree

‎readme.md‎

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,35 @@
22

33
Reviewed GitHub releases for Ruby gems, using `bake-gem` for branch preparation, independent content validation, and clean builds.
44

5-
- `gem:github:release:patch` / `minor` / `major`: prepare, push and open a release PR.
6-
- `gem:github:setup`: generate the three workflows and native review/CI policy.
7-
- `gem:github:setup:plan` / `apply`: inspect and apply the managed GitHub rulesets.
8-
- `gem:github:release:resume run=ID`: retry with the original artifact.
5+
[![Development Status](https://github.com/socketry/bake-gem-github/workflows/Test/badge.svg)](https://github.com/socketry/bake-gem-github/actions?workflow=Test)
96

10-
Read [the setup, release and recovery guide](https://github.com/socketry/bake-gem-github/blob/main/guides/getting-started/readme.md) before enabling publishing. Context is distributed through `agent-context`. Requires `bake-gem` 0.15 or later.
7+
## Motivation
118

12-
## Making Releases
9+
Maintainers need a shared release process that they can run locally or through GitHub. This gem prepares release pull requests for review, validates their generated content, and publishes the merged release through GitHub Actions using RubyGems Trusted Publishing. Retained artifacts and attestations allow interrupted releases to resume using the original verified bytes.
10+
11+
## Usage
12+
13+
Please see the [project documentation](https://socketry.github.io/bake-gem-github/) or run it locally using `bake utopia:project:serve`.
14+
15+
## Contributing
16+
17+
We welcome contributions to this project.
18+
19+
1. Fork the repository.
20+
2. Create your feature branch (`git checkout -b my-new-feature`).
21+
3. Commit your changes (`git commit -am 'Add some feature.'`).
22+
4. Push to the branch (`git push origin my-new-feature`).
23+
5. Create a new pull request.
24+
25+
### Running Tests
26+
27+
To run the test suite:
28+
29+
``` bash
30+
$ bundle exec sus
31+
```
32+
33+
### Making Releases
1334

1435
To prepare a release branch and open a pull request from an up-to-date `main`:
1536

@@ -19,10 +40,10 @@ $ bundle exec bake gem:github:release:patch # or minor or major
1940

2041
See [bake-gem-github](https://github.com/socketry/bake-gem-github) for setup, remote releases, and recovery.
2142

22-
## Development
43+
### Developer Certificate of Origin
2344

24-
Run `bundle exec bake test` for the test suite and `bundle exec rubocop` for style checks. The test, coverage, documentation, and RuboCop workflows follow `bake modernize` conventions.
45+
In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
2546

26-
Install maintenance dependencies with `BUNDLE_WITH=maintenance bundle install`, then run `BUNDLE_WITH=maintenance bundle exec bake agent:context:install` for local agent guidance. Generated `agents.md` and `.agents/context/` files are ignored.
47+
### Community Guidelines
2748

28-
Review modernization changes before committing them. Retain the Socketry certificate, the `~/.gem/socketry-release.pem` signing key path, and packaged release templates. Publishing is handled by `release-publish.yaml`; do not add a second publishing hook to `bake.rb`.
49+
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

0 commit comments

Comments
 (0)