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

📖 docs: add installation instructions for mac and linux #1378

Merged
merged 1 commit into from
Dec 9, 2021
Merged

📖 docs: add installation instructions for mac and linux #1378

merged 1 commit into from
Dec 9, 2021

Conversation

JamieMagee
Copy link
Contributor

  • Please check if the PR fulfills these requirements
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    Adds installation instructions for HomeBrew, NixOS, and Arch Linux

  • What is the current behavior? (You can also link to an open issue here)
    N/A

  • What is the new behavior (if this is a feature change)?
    N/A

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    No

  • Other information:

@JamieMagee JamieMagee temporarily deployed to integration-test December 8, 2021 19:52 Inactive
@github-actions
Copy link

github-actions bot commented Dec 8, 2021

Integration tests success for
[e1689b2]
(https://github.com/ossf/scorecard/actions/runs/1555712886)

You can use [Homebrew](https://brew.sh/) (on macOS or Linux) to install Scorecards.

```sh
brew install scorecard
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this actually work? I thought we don't have homebrew setup. @developer-guy fyi

Copy link
Member

Choose a reason for hiding this comment

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

Looks like there is an existing https://formulae.brew.sh/formula/scorecard#default

Copy link
Member

Choose a reason for hiding this comment

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

Looks like this is also maintained by the community.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, in that case do we need #1376?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need this now. cc @developer-guy


| Package Manager | Linux Distribution | Command |
|------------------------------------------------------------|--------------------|--------------------------------------------|
| Nix | NixOS | `nix-env -iA nixpkgs.scorecard` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Same question here. We don't have this setup AFAIK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Can we add this is maintained by the community https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/security/scorecard/default.nix? This will help with the expectations.

Copy link
Contributor

Choose a reason for hiding this comment

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

pretty much any package via a package manager is maintained by the "community", excluding the big businesses such as RedHat, OpenSUSE, Canonical

unless if you mean the distinction between the official arch repositories and the community AUR or the official brew repositories and separate casks. If that's the distinction we're using then this is an "official" package in the official nixpkgs, the AUR equivalent in nix/nixpkgs is the NUR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @06kellyjac!

Copy link
Member

@naveensrinivasan naveensrinivasan left a comment

Choose a reason for hiding this comment

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

Thanks,I am good with this. I will let @laurentsimon make a call.

You can use [Homebrew](https://brew.sh/) (on macOS or Linux) to install Scorecards.

```sh
brew install scorecard
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this is also maintained by the community.

Copy link
Contributor

@azeemshaikh38 azeemshaikh38 left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @JamieMagee !

@naveensrinivasan naveensrinivasan merged commit 7777139 into ossf:main Dec 9, 2021
@JamieMagee JamieMagee deleted the installation branch December 9, 2021 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants