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

Overhaul README #3995

Merged
merged 10 commits into from
Aug 4, 2024
Merged

Overhaul README #3995

merged 10 commits into from
Aug 4, 2024

Conversation

pat-s
Copy link
Contributor

@pat-s pat-s commented Aug 1, 2024

Long overdue.

I applied some subjective changes, feedback welcome.

@pat-s pat-s requested a review from a team August 1, 2024 14:20
README.md Outdated Show resolved Hide resolved
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.

Can you remove the red/orange box around the screenshot?

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pat-s
Copy link
Contributor Author

pat-s commented Aug 1, 2024

Can you remove the red/orange box around the screenshot?

This is the outline of my browser. But I can redo the screenshot with another browser.

@pat-s pat-s requested a review from qwerty287 August 2, 2024 15:40
@hg
Copy link
Contributor

hg commented Aug 3, 2024

Would you consider including some examples of the environment variables that are available in CI? E.g. something like this. When I'm writing build scripts, I often find myself wondering about the format of a value for a particular environment variable, and have to run a test job to find out.

@qwerty287
Copy link
Contributor

In the readme? I wouldn't do this. In the docs it would be fine

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.

Fine from my side, maybe we can wait for more maintainer feedback

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

woodpecker-bot commented Aug 4, 2024

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-3995.surge.sh

Copy link

codecov bot commented Aug 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 26.89%. Comparing base (123c4ae) to head (19e1c4a).
Report is 14 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3995   +/-   ##
=======================================
  Coverage   26.89%   26.89%           
=======================================
  Files         394      394           
  Lines       27467    27467           
=======================================
  Hits         7388     7388           
  Misses      19380    19380           
  Partials      699      699           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pat-s pat-s merged commit 106b6e0 into main Aug 4, 2024
9 checks passed
@pat-s pat-s deleted the update-readme branch August 4, 2024 23:27
@woodpecker-bot woodpecker-bot mentioned this pull request Aug 6, 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
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