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

Make the README less misleading by putting some reasonable defaults in (instead of empty strings '') #302

Merged
merged 6 commits into from
Dec 16, 2024
Merged

Make the README less misleading by putting some reasonable defaults in (instead of empty strings '') #302

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
75164b0
Make the README less misleading by putting some reasonable defaults i…
DilumAluthge Nov 18, 2024
8f261f1
Change `version: ''` to `version: '1'`
DilumAluthge Nov 18, 2024
e47e95a
Apply suggestions from code review
DilumAluthge Nov 18, 2024
72b4af0
Apply suggestions from code review
DilumAluthge Nov 18, 2024
7318cce
Probably don't need those backticks
DilumAluthge Nov 18, 2024
e2351a9
Merge branch 'master' into dpa/readme
DilumAluthge Dec 16, 2024
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 @@ -41,7 +41,7 @@ This action sets up a Julia environment for use in actions by downloading a spec
# For example, `1.10` may be parsed as `1.1`.
#
# Default: '1'
Comment on lines 42 to 43
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#
# Default: '1'

version: ''
version: '1'

# The architecture of the Julia binaries.
#
Expand All @@ -53,8 +53,8 @@ This action sets up a Julia environment for use in actions by downloading a spec
#
# Note: you can use X64, X86, and ARM64 as synonyms for x64, x86, and aarch64, respectively.
#
# Defaults to the architecture of the runner executing the job.
arch: ''
# Specifying 'default' uses the architecture of the runner executing the job.
arch: 'default'

# Set the display setting for printing InteractiveUtils.versioninfo() after installing.
#
Expand All @@ -70,12 +70,12 @@ This action sets up a Julia environment for use in actions by downloading a spec
# never: Never print versioninfo
#
# Default: false
Comment on lines 71 to 72
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#
# Default: false

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmmm. I'm a bit conflicted on this. I don't know if the following line (show-versioninfo: 'false') makes it sufficiently clear that false is the default value. I think I'd probably lean towards keeping the line that clarifies that false is the default value.

show-versioninfo: ''
show-versioninfo: 'false'

# Set the path to the project directory or file to use when resolving some versions (e.g. `min`).
#
# Defaults to using JULIA_PROJECT if defined, otherwise '.'
project: ''
project: ${{ env.JULIA_PROJECT }} or '.' (if JULIA_PROJECT is unset)
```

### Outputs
Expand Down
Loading