Skip to content

Commit

Permalink
Updating README, adding '.editorconfig', and other small tidy up
Browse files Browse the repository at this point in the history
  • Loading branch information
dmorgan-fa committed May 1, 2024
1 parent 91bfbfe commit c75edfc
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
# Unix-style newlines with a newline ending every file
end_of_line = lf
insert_final_newline = true

[*.{yml,yaml}]
quote_type = double

[*.md]
trim_trailing_whitespace = false
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,14 @@ config.all_sso_sessions
- run `rubocop` for any `ruby` files

If for some reason it's necessary, it's possible to temporarily skip `lefthook` with: `LEFTHOOK=0 git commit`.

### Create a new release
Following (Sematic Versioning)[https://semver.org/], bump the version:
1. `gem bump --version "<sem_ver_bump>"`and merge the changes to `main`
1. The [Release and Build Gem](https://github.com/fac/aws_local_config_parser/actions/workflows/release_gem.yml) wokflow will trigger a new version build
1. Manually create a new [release](https://github.com/fac/int-env-management-module/releases):
1. Click on `Draft a new release`
1. In the `Choose a tag` dropdown, selecting the new version
1. Click `Generate release notes` and review the notes
1. Ensure `Set as the latest release` is checked
1. Click `Publish release`
4 changes: 0 additions & 4 deletions sig/aws_local_config_parser.rbs

This file was deleted.

0 comments on commit c75edfc

Please sign in to comment.