[PP-7517] Initial gem setup with CI, release and dependency management#1
Merged
[PP-7517] Initial gem setup with CI, release and dependency management#1
Conversation
f58982c to
153a30a
Compare
brucebolt
reviewed
Feb 16, 2026
.ruby-version
Outdated
- Gem setup:
- `govuk_content_item_loader.gemspec` to define gem specifications (name,
version, dependencies)
- `CHANGELOG.md` to make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project
- `Gemfile` for managing dependencies
- `Rakefile` to facilitate common tasks
- `README.md` to provide an overview of the gem, later installation
instructions and usage examples
- `LICENCE` file to specify the licensing terms of the gem in line with
https://gds-way.digital.cabinet-office.gov.uk/manuals/licensing.html#specifying-the-licence
- Main library files:
- `lib/`: Directory to include the core gem code.
- `lib/govuk_content_item_loader/`: For the gem's primary functionality.
- `govuk_content_item_loader.rb`: Main class/module implementing the
functionality.
- `version.rb`: Defines the gem version.
- RSpec setup for testing incl. simplecov for test coverage
- GitHub workflows:
- `.github/workflows/ci.yml`: Continuous integration setup for running tests
and linting.
- `.github/workflows/autorelease.yml`: Automates the gem release process.
- `.github/workflows/actionlint.yml`: Lints GitHub Actions workflows to
ensure consistency.
- `.github/workflows/gem-bump-checker.yml`: Checks for version bumps in a PR
to ensure timely releases.
- Dependency management:
- `.github/dependabot.yml`: Configuration file for Dependabot to
automatically create pull requests for dependency updates.
- `.govuk_dependabot_merger.yml`: Configuration for the custom Dependabot
merger tool to automate merging of approved dependency updates.
- Development setup:
- `.gitignore`: Specifies files and directories to be ignored by Git.
- `.rspec`: RSpec configuration file for running tests.
- `.rubocop.yml`: RuboCop configuration for code style enforcement.
- `.ruby-version`: Specifies the Ruby version used for this gem.
153a30a to
788ead0
Compare
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.
Gem setup:
govuk_content_item_loader.gemspecto define gem specifications (name, version, dependencies)Gemfilefor managing dependenciesCHANGELOG.mdto make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the projectRakefileto facilitate common tasksREADME.mdto provide an overview of the gem, later installation instructions and usage examplesLICENCEfile to specify the licensing terms of the gem in line with https://gds-way.digital.cabinet-office.gov.uk/manuals/licensing.html#specifying-the-licenceMain library files:
lib/: Directory to include the core gem code.lib/govuk_content_item_loader/: For the gem's primary functionality.version.rb: Defines the gem version.govuk_content_item_loader.rb: Main class/module implementing the functionality.RSpec setup for testing incl. simplecov for test coverage
GitHub workflows:
.github/workflows/ci.yml: Continuous integration setup for running tests and linting..github/workflows/autorelease.yml: Automates the gem release process..github/workflows/actionlint.yml: Lints GitHub Actions workflows to ensure consistency..github/workflows/gem-bump-checker.yml: Checks for version bumps in a PR to ensure timely releases.Dependency management:
.github/dependabot.yml: Configuration file for Dependabot to automatically create pull requests for dependency updates..govuk_dependabot_merger.yml: Configuration for the custom Dependabot merger tool to automate merging of approved dependency updates.Development setup:
.gitignore: Specifies files and directories to be ignored by Git..rspec: RSpec configuration file for running tests..rubocop.yml: RuboCop configuration for code style enforcement..ruby-version: Specifies the Ruby version used for this gem.