Skip to content

Commit d93e64c

Browse files
svenvanderburgsjvrijn
authored andcommitted
Change github to gitlab in section 4
1 parent 508c73f commit d93e64c

10 files changed

+93
-95
lines changed

episodes/40-section4-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ as well as increasing knowledge about the codebase across the team.
3333
We will thus look at the benefits of reviewing code,
3434
in particular, the value of this type of activity within a team,
3535
and how this can fit within various ways of team working.
36-
We will see how GitHub can support code review activities via pull requests,
36+
We will see how GitLab can support code review activities via merge requests,
3737
and how we can do these ourselves making use of best practices.
3838

3939
After that, we will look at some general principles of software maintainability

episodes/41-code-review.md

Lines changed: 76 additions & 82 deletions
Large diffs are not rendered by default.

episodes/42-software-reuse.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ some extra syntax to provide ways of formatting them.
141141
A big advantage of them is that they can be read as plain-text files
142142
or as source files for rendering them with formatting structures,
143143
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.
145145

146146
Let us start writing `README.md` using a text editor of your choice and add the following line.
147147

@@ -213,19 +213,21 @@ with some text describing the link within `[]` followed by the link itself withi
213213
One really neat feature - and a common practice - of using many CI infrastructures is that
214214
we can include the status of running recent tests within our README file.
215215
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):
217217

218218
```markdown
219219
# Inflam
220-
![Continuous Integration build in GitHub Actions](https://github.com/<your_github_username>/python-intermediate-inflammation/actions/workflows/main.yml/badge.svg?branch=main)
220+
![Continuous Integration build in GitLab CI/CD](https://ci.tno.nl/gitlab/<namespace>/python-intermediate-inflammation/badges/main/pipeline.svg?ignore_skipped=true)
221221
...
222222
```
223223

224224
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,
226226
essentially showing whether the tests that were run
227227
when the last change was made to the `main` branch succeeded or failed.
228228

229+
For more details, see the [pipeline status badges](https://docs.gitlab.com/user/project/badges/) documentation page.
230+
229231
That's got us started with documenting our code,
230232
but there are other aspects we should also cover:
231233

@@ -368,9 +370,9 @@ $ git push origin main
368370

369371
The software on your `main` branch is now ready for release.
370372

371-
## Tagging a Release in GitHub
373+
## Tagging a Release in GitLab
372374

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.
374376
One of these is via **tagging**,
375377
where we attach a human-readable label to a specific commit.
376378
Let us see what tags we currently have in our repository:
@@ -432,7 +434,7 @@ index 4818abb..5b8e7fd 100644
432434
+## Installation
433435
+- Clone the repo ``git clone repo``
434436
+- Check everything runs by running ``python -m pytest`` in the root directory
435-
+- Hurray
437+
+- Hurray
436438
+
437439
+## Contributing
438440
+- Create an issue [here](https://github.com/Onoddil/python-intermediate-inflammation/issues)
@@ -459,7 +461,7 @@ index 4818abb..5b8e7fd 100644
459461
\ No newline at end of file
460462
```
461463

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.
463465
You can push this tag to your remote by doing:
464466

465467
```bash
@@ -487,7 +489,7 @@ e.g. 1.0.0-alpha1 (first alpha release) or 1.2.3-beta4 (fourth beta release)
487489
::::::::::::::::::::::::::::::::::::::::::::::::::
488490

489491
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,
491493
it appears as a specific release within our code repository
492494
which can be downloaded in compressed `.zip` or `.tar.gz` formats.
493495
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
503505

504506
We may also wish to make data available to either
505507
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.
507509
An important aspect to remember with sharing data on such systems is that
508510
they may reside in other countries,
509511
and we must be careful depending on the nature of the data.

episodes/43-software-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ This is because someone installing our software through a tool like `pip` is onl
213213
but probably does not intend to contribute to the development of our software
214214
and does not require development dependencies.
215215

216-
In contrast, if someone downloads our code from GitHub,
216+
In contrast, if someone downloads our code from GitLab,
217217
together with our `pyproject.toml`,
218218
and installs the project that way,
219219
they will get both our runtime and development dependencies.

episodes/fig/code-review-sequence-diagram.svg

Lines changed: 3 additions & 1 deletion
Loading
352 KB
Loading
216 KB
Loading
98.9 KB
Loading
235 KB
Loading
171 KB
Loading

0 commit comments

Comments
 (0)