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

Add examples of CI environment variable values #4009

Merged
merged 2 commits into from
Aug 17, 2024

Conversation

hg
Copy link
Contributor

@hg hg commented Aug 6, 2024

Not sure if you're interested in this; if not, I'll just keep it for my own reference.

I find it useful when writing build scripts because sometimes the exact way a value is formatted is not obvious, and you have to run a test job to find out.

Drone has something similar, but in a much less convenient form, spread over dozens of pages:

etc.

@qwerty287 qwerty287 added the documentation docu & docs label Aug 6, 2024
@woodpecker-bot
Copy link
Collaborator

woodpecker-bot commented Aug 6, 2024

Deployment of preview was torn down

Copy link
Contributor

@pat-s pat-s left a comment

Choose a reason for hiding this comment

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

I like the idea in general.
I don't think we should format all values as code, I'd prefer to have them as plain text instead.

@qwerty287
Copy link
Contributor

I wouldn't say so... I prefer code

@pat-s
Copy link
Contributor

pat-s commented Aug 6, 2024

Then let's hear more opinions - @woodpecker-ci/maintainers

@hg
Copy link
Contributor Author

hg commented Aug 16, 2024

Here's how they get rendered (at least by GitHub): code, plain text, the middle ground (wrap list items and URLs that were not parsed correctly).

@qwerty287
Copy link
Contributor

I still prefer code (except lists, the separator shouldn't be part of the code)

Copy link
Contributor

@qwerty287 qwerty287 left a comment

Choose a reason for hiding this comment

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

It looks like @anbraten and @xoxys prefer code so I'd go on with this. You have to run prettier though, this isn't that easy with giyhu suggestions...

docs/docs/20-usage/50-environment.md Outdated Show resolved Hide resolved
docs/docs/20-usage/50-environment.md Outdated Show resolved Hide resolved
docs/docs/20-usage/50-environment.md Outdated Show resolved Hide resolved
@hg
Copy link
Contributor Author

hg commented Aug 17, 2024

Thanks, I applied all three and reformatted the file with prettier.

@6543 6543 enabled auto-merge (squash) August 17, 2024 10:58
@6543 6543 merged commit 0b34578 into woodpecker-ci:main Aug 17, 2024
6 of 7 checks passed
@woodpecker-bot woodpecker-bot mentioned this pull request Aug 17, 2024
1 task
6543 pushed a commit to 6543-forks/woodpecker that referenced this pull request Sep 5, 2024
@woodpecker-bot woodpecker-bot mentioned this pull request Sep 8, 2024
1 task
@woodpecker-bot woodpecker-bot mentioned this pull request Dec 14, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation docu & docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants