-
Notifications
You must be signed in to change notification settings - Fork 286
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into dependabot/github_actions/tspascoal/get-user…
…-teams-membership-3
- Loading branch information
Showing
68 changed files
with
2,102 additions
and
653 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # For most projects, this workflow file will not need changing; you simply need | ||
| # to commit it to your repository. | ||
| # | ||
| # You may wish to alter this file to override the set of languages analyzed, | ||
| # or to provide custom queries or build logic. | ||
| # | ||
| # ******** NOTE ******** | ||
| # We have attempted to detect the languages in your repository. Please check | ||
| # the `language` matrix defined below to confirm you have the correct set of | ||
| # supported CodeQL languages. | ||
| # | ||
| name: "CodeQL" | ||
|
|
||
| on: | ||
| push: | ||
| branches: ["main", "v[0-9].[0-9].x", "v[0-9].[0-9][0-9].x", "v[0-9].x"] | ||
| schedule: | ||
| - cron: '24 20 * * 4' | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: Analyze | ||
| # Runner size impacts CodeQL analysis time. To learn more, please see: | ||
| # - https://gh.io/recommended-hardware-resources-for-running-codeql | ||
| # - https://gh.io/supported-runners-and-hardware-resources | ||
| # - https://gh.io/using-larger-runners | ||
| # Consider using larger runners for possible analysis time improvements. | ||
| runs-on: 'ubuntu-latest' | ||
| timeout-minutes: 360 | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: ['go'] | ||
| # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| # Initializes the CodeQL tools for scanning. | ||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v2 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| # If you wish to specify custom queries, you can do so here or in a config file. | ||
| # By default, queries listed here will override any specified in a config file. | ||
| # Prefix the list here with "+" to use these queries and those in the config file. | ||
|
|
||
| # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | ||
| # queries: security-extended,security-and-quality | ||
|
|
||
|
|
||
| # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). | ||
| # If this step fails, then you should remove it and run the build manually (see below) | ||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@v2 | ||
|
|
||
| # ℹ️ Command-line programs to run using the OS shell. | ||
| # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
|
|
||
| # If the Autobuild fails above, remove it and uncomment the following three lines. | ||
| # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||
|
|
||
| # - run: | | ||
| # echo "Run, Build Application using script" | ||
| # ./location_of_script_within_repo/buildscript.sh | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@v2 | ||
| with: | ||
| category: "/language:${{matrix.language}}" |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,8 @@ node | | | | | |
|
|
||
| ## Install | ||
|
|
||
| ### Source | ||
|
|
||
| 1. [Install Go](https://go.dev/doc/install) 1.21.1 | ||
| 1. Clone this repo | ||
| 1. Install the celestia-app CLI | ||
|
|
@@ -44,6 +46,57 @@ node | | | | | |
| make install | ||
| ``` | ||
|
|
||
| ### Pre-built binary | ||
|
|
||
| If you'd rather not install from source, you can download a pre-built binary from the [releases](https://github.com/celestiaorg/celestia-app/releases) page. | ||
| 1. Navigate to the latest release on <https://github.com/celestiaorg/celestia-app/releases>. | ||
| 1. Download the binary for your platform (e.g. `celestia-app_Linux_x86_64.tar.gz`) from the **Assets** section. Tip: if you're not sure what platform you're on, you can run `uname -a` and look for the operating system (e.g. `Linux`, `Darwin`) and architecture (e.g. `x86_64`, `arm64`). | ||
| 1. Extract the archive | ||
| ```shell | ||
| tar -xvf celestia-app_Linux_x86_64.tar.gz | ||
| ``` | ||
| 1. Verify the extracted binary works | ||
| ```shell | ||
| ./celestia-appd --help | ||
| ``` | ||
| #### Optional: Verify the pre-built binary checksums and signatures | ||
| If you use a pre-built binary, you may also want to verify the checksums and signatures. | ||
| 1. Navigate to the latest release on <https://github.com/celestiaorg/celestia-app/releases>. | ||
| 1. Download `checksums.txt`, `checksums.txt.sig`, and the binary for your platform (e.g. `celestia-app_Linux_x86_64.tar.gz`) from the **Assets** section. Tip: if you're not sure what platform you're on, you can run `uname -a` and look for the operating system (e.g. `Linux`, `Darwin`) and architecture (e.g. `x86_64`, `arm64`). | ||
| 1. Verify the checksums | ||
| ```shell | ||
| sha256sum --ignore-missing --check checksums.txt | ||
| ``` | ||
| You should see output like this: | ||
| ```shell | ||
| celestia-app_Linux_x86_64.tar.gz: OK | ||
| ``` | ||
| 1. Download the [verify-signature.sh](./scripts/signing/verify-signature.sh) script. | ||
| 1. Verify the signature via the [verify-signature.sh](./scripts/signing/verify-signature.sh) script | ||
| ```shell | ||
| ./verify-signature.sh checksums.txt.sig checksums.txt | ||
| ``` | ||
| You should see output like this: | ||
| ```shell | ||
| gpg: Signature made Thu Sep 21 14:39:26 2023 EDT | ||
| gpg: using EDDSA key BF02F32CC36864560B90B764D469F859693DC3FA | ||
| gpg: Good signature from "celestia-app-maintainers <[email protected]>" [ultimate] | ||
| ``` | ||
| ### Ledger Support | ||
| Ledger is not supported on Windows and OpenBSD. | ||
|
|
@@ -115,33 +168,6 @@ make proto-gen | |
| make goreleaser-build | ||
| ``` | ||
| ### Publishing a Release | ||
|
|
||
| > **NOTE** Due to `goreleaser`'s CGO limitations, cross-compiling the binary does not work. So the binaries must be built on the target platform. This means that the release process must be done on a Linux amd64 machine. | ||
| To generate the binaries for the Github release, you can run the following command: | ||
| ```sh | ||
| make goreleaser-release | ||
| ``` | ||
| This will generate the binaries as defined in `.goreleaser.yaml` and put them in `build/goreleaser` like so: | ||
| ```sh | ||
| build | ||
| └── goreleaser | ||
| ├── CHANGELOG.md | ||
| ├── artifacts.json | ||
| ├── celestia-app_Linux_x86_64.tar.gz | ||
| ├── celestia-app_linux_amd64_v1 | ||
| │ └── celestia-appd | ||
| ├── checksums.txt | ||
| ├── config.yaml | ||
| └── metadata.json | ||
| ``` | ||
| For the Github release, you just need to upload the `checksums.txt` and `celestia-app_Linux_x86_64.tar.gz` files. | ||
| ### Docs | ||
| Package-specific READMEs aim to explain implementation details for developers that are contributing to these packages. The [specs](https://celestiaorg.github.io/celestia-app/) aim to explain the protocol as a whole for developers building on top of Celestia. | ||
|
|
@@ -153,7 +179,7 @@ Package-specific READMEs aim to explain implementation details for developers th | |
| ## Audits | ||
| [Informal Systems](https://informal.systems/) audited celestia-app [v1.0.0-rc6](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc6) in Q3 of 2023. See [audit/informal-systems.pdf](audit/informal-systems.pdf) for the full report. | ||
| [Informal Systems](https://informal.systems/) audited celestia-app [v1.0.0-rc6](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc6) in Q3 of 2023. See [docs/audit/informal-systems.pdf](docs/audit/informal-systems.pdf) for the full report. | ||
| ## Careers | ||
|
|
||
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
Oops, something went wrong.