@@ -133,7 +133,7 @@ $ curl https://raw.githubusercontent.com/alire-project/ada_spark_workflow/main/.
133
133
134
134
To see the code coverage reports in GitHub pull-requests and have a dedicated page for coverage status, you have to setup the repository in codecovio.
135
135
136
- - First create and account and log-in: https://about.codecov.io/
136
+ - First create an account and log-in: https://about.codecov.io/
137
137
- Click on "Not Yet Setup" (#1 below) to show the list of repositories available.
138
138
- Click on "setup repo" (#2 below) to enable codecovio on the new repository
139
139
- If the GitHub repository is public, you don't have to do anything more
@@ -161,15 +161,15 @@ To be able to read the resource files, one needs to get a path to the resource f
161
161
``` console
162
162
$ alr with resources
163
163
```
164
- 2 . Instantiate the ` Resources ` generic package in your code. For examples :
164
+ 2 . Instantiate the ` Resources ` generic package in your code. For example :
165
165
``` ada
166
166
with Resources;
167
167
with Ada_Spark_Workflow_Config;
168
168
169
169
package Ada_SPARK_Workflow.Resources
170
170
is new Standard.Resources (Ada_Spark_Workflow_Config.Crate_Name);
171
171
```
172
- Note that you should replace ` Ada_Spark_Workflow ` with you crate name here.
172
+ Note that you should replace ` Ada_Spark_Workflow ` with your crate name here.
173
173
174
174
3 . Get path to resources using this new package:
175
175
``` ada
@@ -228,7 +228,7 @@ Given a version number MAJOR.MINOR.PATCH, increment the:
228
228
```
229
229
230
230
The point is that a given crate ` A ` made to depend on version ` 1.2.3 ` of
231
- another crate ` B ` , can safely be compiled with version any of ` B ` between
231
+ another crate ` B ` , can safely be compiled with any version of ` B ` between
232
232
` 1.0.0 ` and ` 2.0.0 ` . Alire uses this system to find releases that satisfy all
233
233
the dependency requirements of the different crates used.
234
234
@@ -262,7 +262,7 @@ Let's look at some examples given a current version at `1.2.4-dev`:
262
262
## Version of main/master/development branch
263
263
264
264
We recommend using the ` -dev ` suffix for the version number of the development
265
- branch. For instance: ` 1.2.4-dev ` . This communicates that the crate the code is
265
+ branch. For instance: ` 1.2.4-dev ` . This communicates that the crate code is
266
266
not in a release state, API might change, documentation might be lacking, etc.
267
267
268
268
## Release workflow
@@ -274,7 +274,7 @@ The procedure is different for `MAJOR/MINOR` releases and `PATCH` releases.
274
274
275
275
### ` MAJOR/MINOR ` Releases
276
276
277
- We recommended using a separate branch for each ` MAJOR/MINOR ` release, i.e.
277
+ We recommend using a separate branch for each ` MAJOR/MINOR ` release, i.e.
278
278
when the ` MINOR ` or ` MAJOR ` version number is increased:
279
279
- ` release/1.0 `
280
280
- ` release/1.1 `
@@ -284,7 +284,7 @@ when the `MINOR` or `MAJOR` version number is increased:
284
284
285
285
The procedure is:
286
286
- From the development branch
287
- - Create a new branch: ` $ git co -b release/X.Y `
287
+ - Create a new branch: ` $ git checkout -b release/X.Y `
288
288
- Update the version number in ` alire.toml `
289
289
- Push the branch to the repo: ` $ git push `
290
290
- Create a release from the GitHub web interface
@@ -301,7 +301,7 @@ For `PATCH` release (e.g `1.2.3`) use the corresponding release branch
301
301
(` release/1.2 ` ).
302
302
303
303
The procedure is:
304
- - Check-out the release branch: ` $ git co -b release/1.2 origin/release/1.2 `
304
+ - Check-out the release branch: ` $ git checkout -b release/1.2 origin/release/1.2 `
305
305
- Commit corrective patches or cherry-pick from the development branch
306
306
- Update the ` PATCH ` version number in ` alire.toml `
307
307
- Push the branch to the repo: ` $ git push `
0 commit comments