Specify an (optional) private leaderboardId as input #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k2bd
reviewed
Dec 2, 2021
README.md
Outdated
Comment on lines
58
to
71
| ### `leaderboardId` | ||
|
|
||
| **Optional** | ||
|
|
||
| Your Advent of Code leaderboard ID. | ||
| To get this, go to your Go to [leaderboard](https://adventofcode.com/2020/leaderboard/private) and press 'View'. | ||
| The leaderboard ID is at the end of the URL: | ||
|
|
||
| ``` | ||
| https://adventofcode.com/2021/leaderboard/private/view/(leaderboard ID) | ||
| ``` | ||
|
|
||
| If not provided it will be derived from the userId parameter | ||
|
|
There was a problem hiding this comment.
Nit: could this be moved after the required fields, and adopt consistent text formatting with the other optional fields?
e.g.
### `tableMarker`
*Optional* - default `<!--- advent_readme_stars table --->`
Description...| @@ -44,6 +44,7 @@ jobs: | |||
| - uses: k2bd/advent-readme-stars@v1 | |||
| with: | |||
| userId: 1234567 | |||
| leaderboardId: 9876543 | |||
There was a problem hiding this comment.
Nit: in the lines above, could the text "pasting in yout user ID instead of 1234567:" be replaced with "pasting in your user ID and leaderboard ID"?
|
Hey, thanks for the feedbacks! |
|
LGTM! Thanks a lot 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enriches the action by allowing to specify the Advent of Code private leaderboard ID to handle the scenario when a user has joined a private leaderboard created by another user (the private leaderboard id URL includes the id of the user that created the leaderboard).
The leaderboard ID input parameter is optional and if left blank it is defaulted to the userId, in order to maintain backwards compatibility.