Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README.md #7

Merged
merged 7 commits into from
Feb 27, 2025
Merged

Update the README.md #7

merged 7 commits into from
Feb 27, 2025

Conversation

lisahligono
Copy link
Contributor

This PR adds setup procedures for the workflow repository

README.md Outdated
@@ -4,6 +4,11 @@ Copyright 2022-2024 IIASA

[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

## Setup
- Clone this repository or create a repository using this template repository.
- Add a webhook in the repository.
Copy link
Member

Choose a reason for hiding this comment

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

Please clarify that these should be two webhooks, write them explicitly, and add where to get the secret.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Specified where to get the two webhooks together with the secret.

Copy link
Member

@danielhuppmann danielhuppmann left a comment

Choose a reason for hiding this comment

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

One minor style issue, looks good to me, thanks! But maybe @phackstock has more ideas about useful content to add...

Copy link
Contributor

@phackstock phackstock left a comment

Choose a reason for hiding this comment

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

Couple of comments in line, after that good to be merged.

README.md Outdated
- Add two webhooks in `<workflow-name>-workflow` repository. What is referred to as token in the Payload URL is actually just a identifier of a Jenkins job, no need to keep that secret. Copy it from any other workflow webhook settings.

```
Payload URL 1: https://builds.ece.iiasa.ac.at/generic-webhook-trigger/invoke?token=<token>
Copy link
Contributor

Choose a reason for hiding this comment

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

Since as you as above, there's no need to keep the tokens secret, I'd say you can just add them here.

README.md Outdated

```
Payload URL 1: https://builds.ece.iiasa.ac.at/generic-webhook-trigger/invoke?token=<token>
Payload URL 2: https://next-builds.ece.iiasa.ac.at/generic-webhook-trigger/invoke?token=<token>
Copy link
Contributor

Choose a reason for hiding this comment

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

Since as you as above, there's no need to keep the tokens secret, I'd say you can just add them here.

lisahligono and others added 3 commits February 21, 2025 10:08
Co-authored-by: Daniel Huppmann <[email protected]>
Co-authored-by: Philip Hackstock <[email protected]>
Copy link
Contributor

@phackstock phackstock left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @lisahligono.
Good to be merged from my side.

@phackstock phackstock merged commit f0db20a into main Feb 27, 2025
3 checks passed
@phackstock phackstock deleted the update/readme branch February 27, 2025 10:50
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