Skip to content

Autumn 2026 review - #246

Merged
mmesiti merged 8 commits into
coderefinery:mainfrom
mmesiti:aut2026review
Sep 17, 2026
Merged

mmesiti merged 8 commits into
coderefinery:mainfrom
mmesiti:aut2026review

Conversation

@mmesiti

@mmesiti mmesiti commented Sep 9, 2026 •

Copy link
Copy Markdown
Contributor

Tries to address all issues in #245.

This PR will contain many independent bits, please use the code review feature to choose which changes should be approved.
I will add comments there too.

View the content rendered: https://mmesiti.github.io/cr-testing/branch/aut2026review/cloud/ (haven't thanked @frankier for finding and showing me the trick to see the rendering of branches other than main, and also @rkdarst for adding that feature to the github workflow).

I can't add @Vinye to the reviewers it seems, but she's definitely got a say here :-)

Updated 10.09 with link to rendered pages

Added keypoints about GitHub Actions and CI/CD setup.
Related to first comment in coderefinery#245.
Add lesson description in index as in the git intro
https://coderefinery.github.io/git-intro/
stress automated vs non automated testing
also, add definition of CI
and common meaning of CI
continuous integration is a "difficult" expression,
meaning originally the practice of merging into main/master/trunk
often,
then slightly abused because of GitLab CI.

Co-Authored-by: Anja Virkkunen <anja.virkkunen@aalto.fi>

@johanhellsvik johanhellsvik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good editing and additions to the lesson contents. Highlighting here a few things that I think are good improvements

  • The new contents under "In this lesson we discuss the basics of automated testing." read well.
  • The extended "Testing vocabulary" is most valuable.
  • The change of wording "continuous integration" -> "cloud" as in the change"Exercise CI-1: Create and use a continuous integration workflow on GitHub or GitLab" to "Exercise CI-1: Create and use a workflow on GitHub or a pipeline on GitLab" is good for clarity. I agree that the expression "continuous integration" can have different meanings in different contexts.

My only specific suggestion for change/addition is that one could perhaps somewhere that a workflows/pipelines need not necessarily be on the cloud, but could alternatively be on e.g. a self hosted GitHub or GitLab server.

Comment thread content/remotely.md
This exercise can be run in "collaborative mode" by following instead the instructions
in [Full-cycle collaborative workflow](./full-cycle-ci). In the collaborative version steps
C-D below are performed by a collaborator.


```{challenge} Exercise CI-1: Create and use a continuous integration workflow on GitHub or GitLab
```{challenge} Exercise CI-1: Create and use a workflow on GitHub or a pipeline on GitLab

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This exercise is rendered inside the above note, is that intentional?
I'm looking at this: https://mmesiti.github.io/cr-testing/branch/aut2026review/cloud/

I don't know enough sphinx syntax to resolve this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be sufficient to add a "" before the challenge block, to properly close the note block. But I can't do this on github with a suggestion, interestingly, because the additional in the suggestion would close the suggestion block instead of being added to the document, and I don't know how to "escape" the "```" so that this doesn't happen...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fixed now (done locally)

@Vinye Vinye left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a proofreading of the changes, caught some minor things 🔎

Comment thread content/full-cycle-ci.md Outdated
Comment thread content/index.rst Outdated
Comment thread content/index.rst Outdated
Comment thread content/locally.md Outdated
Comment thread content/cloud.md Outdated
Comment thread content/full-cycle-ci.md Outdated
Co-Authored-by: Anja Virkkunen <anja.virkkunen@aalto.fi>

Co-authored-by: Michele Mesiti <mmesiti@users.noreply.github.com>
@mmesiti

mmesiti commented Sep 11, 2026

Copy link
Copy Markdown
Contributor Author

Thank you @johanhellsvik for the prompt review!

My only specific suggestion for change/addition is that one could perhaps somewhere that a workflows/pipelines need not necessarily be on the cloud, but could alternatively be on e.g. a self hosted GitHub or GitLab server.

This made me think a bit.

I would have argued that a self hosted github or gitlab server would still qualify as cloud (might be a "private" cloud), BUT I realised that I might be using "cloud" in an improper way (in the same way I thought that "continous integration" was used slightly ambiguously before, so we decided to get rid of the term).

Maybe a more elegant approach would be to get rid of "cloud" and just say "remotely", so we would have

# Automated testing on your computer 
...
# Automated testing remotely

What do you think? Poking @Vinye since she was definitely part of the discussion.

@mmesiti

mmesiti commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor Author

After fixing the cloud/remote wording issue (waiting on your opinion), there are 2 alternative ways to go forward:

  1. In oder to have a clear diff between changes you have already reviewed and further changes: mark this PR as ready for merge, merge it, and make another PR with the other changes mentioned in Autumn 2026 revision #245
  2. In order to keep a bigger picture of all the changes between the current main and the next: keep adding to this PR.

What do @Vinye and @johanhellsvik think? Sorry for spamming mentions.

first we removed "Continous integration"
because of the ambiguity
but then we replaced it with "cloud",
which is also not very clear.

"remote/remotely" is probably the cleanest approach here.
@Vinye

Vinye commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

I would have argued that a self hosted github or gitlab server would still qualify as cloud (might be a "private" cloud), ...

While this is true, for me the word "cloud" first associates with the big providers and it doesn't connect in my head with self-hosting. Remotely is a fine choice, although another word that came to my mind is server, how about it?

Also, now that we are thinking about our word choices to accomodate self-hosting, should we mention self-hosting as an option somewhere? Along the lines of "besides Github Actions and Gitlab pipelines, self-hosting your test servers is also an option, but we won't cover that here"

P.S. I'd prefer merging this (option 1)

@mmesiti
mmesiti marked this pull request as ready for review September 17, 2026 13:58
@mmesiti

mmesiti commented Sep 17, 2026

Copy link
Copy Markdown
Contributor Author

I'd merge this. There will be chances to do further review for another batch of changes. @Vinye ok?

@mmesiti mmesiti mentioned this pull request Sep 17, 2026
@Vinye

Vinye commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

OK

@mmesiti

mmesiti commented Sep 17, 2026

Copy link
Copy Markdown
Contributor Author

My only specific suggestion for change/addition is that one could perhaps somewhere that a workflows/pipelines need not necessarily be on the cloud, but could alternatively be on e.g. a self hosted GitHub or GitLab server.

This is being addressed in #252

@mmesiti
mmesiti merged commit e71e932 into coderefinery:main Sep 17, 2026
2 checks passed
mmesiti added a commit to mmesiti/cr-testing that referenced this pull request Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants