oauth_im 0.4.7 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +30 -0
- data/lib/oauth_im/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3cbef449e4e7e3cb7c22930c0a5a7688d00bd137a955d8ff548542d4f2875572
|
|
4
|
+
data.tar.gz: 528c74b6cd08deb54536029b2e883d4949ac99c1abe2c56b421bbe76a70aa22a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 63bfab0ceb921a9b129277030914e1dfe1bef673b79b2b27fe9042f0d6fb369059dd4a4221862a73dbb18be7ac1d423802bcb8d6ba6e7aaeac20be284261fea6
|
|
7
|
+
data.tar.gz: 98b94db5ac85de15989d3faa7512e63f80535c22dd8562439f439fa143f81dd462cb9e32999f1ea227c8d8b4fc58b7b04436ef48fe6a32ef63442b4c920a35af
|
data/README.md
CHANGED
|
@@ -83,3 +83,33 @@ class ApplicationController < ActionController::Base
|
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
```
|
|
86
|
+
|
|
87
|
+
## Gem Maintenance
|
|
88
|
+
After many false starts, this repo includes two (seemingly functional) github workflows.
|
|
89
|
+
|
|
90
|
+
1. Thanks to [this workflow](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/ci.yml),
|
|
91
|
+
largely copied from the CMS, the specs should run automatically when a PR is issued.
|
|
92
|
+
2. Thanks to [this workflow](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/release.yml)
|
|
93
|
+
based on [this blog post](https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/)
|
|
94
|
+
and using [this release phase action](https://github.com/illustrativemathematics/oauth_im/blob/main/.github/workflows/release.yml),
|
|
95
|
+
certain so-called [conventional commits](https://github.com/google-github-actions/release-please-action#how-should-i-write-my-commits)
|
|
96
|
+
will result in a so-called **release PR**.
|
|
97
|
+
* Per the above documentation, to issue such a commit, use the following format for your commit message:
|
|
98
|
+
* `fix: a comment about a minor change that corresponds to a SemVar patch`
|
|
99
|
+
* `feat: a comment about a feature change that corresponds to a SemVar minor`
|
|
100
|
+
* `fix!: a comment about a breaking change that corresponds to a Semvar major`
|
|
101
|
+
* `feat!: ditto`
|
|
102
|
+
* Once a release PR is accepted and merged, a new PR is created that does several things:
|
|
103
|
+
* The gem is versioned by updating [the version file](https://github.com/illustrativemathematics/oauth_im/blob/main/lib/oauth_im/version.rb#L4).
|
|
104
|
+
* The new PR also includes auto-generated updates to [CHANGELOG.md](https://github.com/illustrativemathematics/oauth_im/blob/main/CHANGELOG.md).
|
|
105
|
+
* If this new PR is accepted and merged, several other things happened:
|
|
106
|
+
* A new tag and github release are created.
|
|
107
|
+
* The new gem version is automatically pushed up to Rubygems.
|
|
108
|
+
|
|
109
|
+
### Notes
|
|
110
|
+
* Because the above process adds new commits to the repository, you
|
|
111
|
+
should remember to pull them.
|
|
112
|
+
* At Rubygems it is difficult to reuse version numbers for gems. For
|
|
113
|
+
this reason, you shouldn't try to force-push updates to gem version
|
|
114
|
+
numbers. Instead, let the automatic process manage versioning for
|
|
115
|
+
you.
|
data/lib/oauth_im/version.rb
CHANGED