@@ -141,7 +141,7 @@ some extra syntax to provide ways of formatting them.
141
141
A big advantage of them is that they can be read as plain-text files
142
142
or as source files for rendering them with formatting structures,
143
143
and are very quick to write.
144
- GitHub provides a very useful [ guide to writing Markdown] [ github-markdown ] for its repositories .
144
+ GitHub provides a very useful [ guide to writing Markdown] [ github-markdown ] that also applies to GitLab .
145
145
146
146
Let us start writing ` README.md ` using a text editor of your choice and add the following line.
147
147
@@ -213,19 +213,21 @@ with some text describing the link within `[]` followed by the link itself withi
213
213
One really neat feature - and a common practice - of using many CI infrastructures is that
214
214
we can include the status of running recent tests within our README file.
215
215
Just below the ` # Inflam ` title on our README.md file,
216
- add the following (replacing ` <your_github_username > ` with your own:
216
+ add the following (replacing ` <namespace > ` and ` <name> ` with your own) :
217
217
218
218
``` markdown
219
219
# Inflam
220
- 
220
+ 
221
221
...
222
222
```
223
223
224
224
This will embed a * badge* (icon) at the top of our page that
225
- reflects the most recent GitHub Actions build status of your software repository,
225
+ reflects the most recent GitLab CI/CD build status of your software repository,
226
226
essentially showing whether the tests that were run
227
227
when the last change was made to the ` main ` branch succeeded or failed.
228
228
229
+ For more details, see the [ pipeline status badges] ( https://docs.gitlab.com/user/project/badges/ ) documentation page.
230
+
229
231
That's got us started with documenting our code,
230
232
but there are other aspects we should also cover:
231
233
@@ -368,9 +370,9 @@ $ git push origin main
368
370
369
371
The software on your ` main ` branch is now ready for release.
370
372
371
- ## Tagging a Release in GitHub
373
+ ## Tagging a Release in GitLab
372
374
373
- There are many ways in which Git and GitHub can help us make a software release from our code.
375
+ There are many ways in which Git and GitLab can help us make a software release from our code.
374
376
One of these is via ** tagging** ,
375
377
where we attach a human-readable label to a specific commit.
376
378
Let us see what tags we currently have in our repository:
@@ -432,7 +434,7 @@ index 4818abb..5b8e7fd 100644
432
434
+## Installation
433
435
+- Clone the repo ``git clone repo``
434
436
+- Check everything runs by running ``python -m pytest`` in the root directory
435
- +- Hurray
437
+ +- Hurray
436
438
+
437
439
+## Contributing
438
440
+- Create an issue [here](https://github.com/Onoddil/python-intermediate-inflammation/issues)
@@ -459,7 +461,7 @@ index 4818abb..5b8e7fd 100644
459
461
\ No newline at end of file
460
462
```
461
463
462
- So now we have added a tag, we need this reflected in our Github repository .
464
+ So now we have added a tag, we need this reflected in our GitLab project .
463
465
You can push this tag to your remote by doing:
464
466
465
467
``` bash
@@ -487,7 +489,7 @@ e.g. 1.0.0-alpha1 (first alpha release) or 1.2.3-beta4 (fourth beta release)
487
489
::::::::::::::::::::::::::::::::::::::::::::::::::
488
490
489
491
We can now use the more memorable tag to refer to this specific commit.
490
- Plus, once we have pushed this back up to GitHub ,
492
+ Plus, once we have pushed this back up to GitLab ,
491
493
it appears as a specific release within our code repository
492
494
which can be downloaded in compressed ` .zip ` or ` .tar.gz ` formats.
493
495
Note that these downloads just contain the state of the repository at that commit,
@@ -503,7 +505,7 @@ but tagging with a specific version number makes that just a little bit easier f
503
505
504
506
We may also wish to make data available to either
505
507
be used with the software or as generated results.
506
- This may be via GitHub or some other means.
508
+ This may be via GitLab or some other means.
507
509
An important aspect to remember with sharing data on such systems is that
508
510
they may reside in other countries,
509
511
and we must be careful depending on the nature of the data.
0 commit comments