You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-1Lines changed: 15 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,22 @@ In order to keep the Curly code base nice and tidy, please observe these best pr
10
10
> In order to avoid nasty errors when doing stuff, make the Curly compiler
11
11
> fail early when an invalid reference is encountered.
12
12
13
-
14
13
Before making a contribution, you should make sure to understand what Curly is and isn't:
15
14
16
15
- The template language will never be super advanced: one of the primary use cases for Curly is to allow end users to mess around with Curly templates and have them safely compiled and rendered on a server. As such, the template language will always be as simple as possible.
17
16
- The template language is declarative, and is going to stay that way.
17
+
18
+
### Releasing a new version
19
+
A new version is published to RubyGems.org every time a change to `version.rb` is pushed to the `main` branch.
20
+
In short, follow these steps:
21
+
1. Update `version.rb`,
22
+
2. update version in all `Gemfile.lock` files,
23
+
3. merge this change into `main`, and
24
+
4. look at [the action](https://github.com/zendesk/curly/actions/workflows/publish.yml) for output.
25
+
26
+
To create a pre-release from a non-main branch:
27
+
1. change the version in `version.rb` to something like `1.2.0.pre.1` or `2.0.0.beta.2`,
28
+
2. push this change to your branch,
29
+
3. go to [Actions → “Publish to RubyGems.org” on GitHub](https://github.com/zendesk/curly/actions/workflows/publish.yml),
0 commit comments