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.

Sign up for GitHub

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

Jump to bottom

Use consistent branch names in README.md #135

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use consistent branch names in README.md #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ jobs:
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo

# add id to action so outputs can be used
- uses: education/autograding@v1
Expand Down Expand Up @@ -209,7 +209,7 @@ To display the points bar, add the following to the top of the assignment README
If you want to float the points bar to the right, use the following instead:

```html
<img alt="points bar" align="right" height="36" src="../../blob/status/.github/badges/points-bar.svg" />
<img alt="points bar" align="right" height="36" src="../../blob/badges/.github/badges/points-bar.svg" />
Copy link
Author

Choose a reason for hiding this comment

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

This was by far the biggest point of confusion for me.

Both previous code snippets were copy-pasteable, so everything would work "out-of-the-box". So I assumed the same for this <img> example, but it failed, and I had to go dig into URL to find out why.

The changes below were just to ensure that the same snippets will work for reusable workflow as well.

```

## Using the Reusable Points Bar Workflow
Expand All @@ -224,7 +224,7 @@ on:
push:
branches:
- '*'
- '!status'
- '!badges'

jobs:
update-points-bar:
Expand All @@ -233,15 +233,15 @@ jobs:
contents: write
with:
points: '10/20'
path: '.github/activity-icons/points-bar.svg'
path: '.github/badges/points-bar.svg'
type: 'bar'
bar-color: '#4c1'
bar-background: '#555'
font-color: '#aaa'
label: 'Points'
width: '100'
reverse: false
branch: status
branch: badges
secrets:
token: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down