Skip to content

Commit

Permalink
Merge pull request #2 from oras-project/main
Browse files Browse the repository at this point in the history
updating the repo uptill my commits
  • Loading branch information
1Shubham7 authored Jul 25, 2023
2 parents e71fca3 + 3cc67cf commit 2ea3ab8
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 40 deletions.
6 changes: 6 additions & 0 deletions docs/commands/oras_login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ Log in with username and password in an interactive terminal and no TLS check:
oras login --insecure localhost:5000
```

Log in to a registry with custom DNS resolution

```bash
oras login prod.registry.io --resolve prod.registry.io:5000:127.0.0.1 --plain-http
```

## Options

```
Expand Down
24 changes: 14 additions & 10 deletions docs/community/community_resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,26 @@ title: Community Resources
sidebar_position: 10
---

# Welcome to the ORAS Project community.
# Welcome to the ORAS Project Community.

- [Join us](https://slack.cncf.io/) at [CNCF Slack](https://cloud-native.slack.com) under the **#oras** channel
- Join the weekly community meeting at 4:00 PM PST at [Zoom meeting room](https://zoom.us/j/8079328631?pwd=UzN0NUlmbmcvTTN5L0o5VUQ2YndyQT09) with ID 807 932 8631. See [meeting notes](https://hackmd.io/P-O6n222TcSMoJgHmTTduw?view) for more details
- Follow us on Twitter: [@orasproject](https://twitter.com/orasproject)
- Subscribe us on [YouTube](https://www.youtube.com/@cncforasproject)
- Join us at [CNCF Slack](https://cloud-native.slack.com) under the **#oras** channel. In case you have not joined the CNCF workspace yet, you can follow the steps mentioned in [this section](#joining-the-slack-channel).
- Join the biweekly community meeting at 4:00 PM PST at [Zoom meeting room](https://zoom.us/j/8079328631?pwd=UzN0NUlmbmcvTTN5L0o5VUQ2YndyQT09) with ID 807 932 8631. See [meeting notes](https://hackmd.io/P-O6n222TcSMoJgHmTTduw?view) for more details.
- Follow us on Twitter: [@orasproject](https://twitter.com/orasproject).
- Subscribe to us on [YouTube](https://www.youtube.com/@cncforasproject).

## Developing and contributing to ORAS
## Joining the Slack Channel
Please follow these steps to connect with the ORAS community on slack:
1. Enter your email ID at the [community inviter](https://slack.cncf.io/) to receive an invite to join the CNCF Workspace.
2. You can join the **#oras** channel via this [link](https://cloud-native.slack.com/archives/CJ1KHJM5Z) or manually add the channel by browsing through the channels on the workspace.
3. You're in! Please feel free to drop a message and connect with folks in the community. 🙂

If you are interested in developing or contributing to ORAS, you can check out the [CLI developer guide](./developer_guide.mdx).
## Developing and Contributing to ORAS

If you are interested in developing or contributing to ORAS, you can check out the [developer guide](./developer_guide.

## Governance

You can find the following documents to understand the community and project governance:

- [ORAS Project Governance](https://github.com/oras-project/community/blob/main/governance/GOVERNANCE.md)
- [ORAS Release Process](https://github.com/oras-project/community/blob/main/governance/RELEASE-PROCESS.md)


- [ORAS Release Process](https://github.com/oras-project/community/blob/main/governance/RELEASE-PROCESS.md)
18 changes: 9 additions & 9 deletions docs/community/contributing_guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 20
# Contributing Guide


* [New Contributor Guide](#contributing-guide)
* [Contributing Guide](#contributing-guide)
* [Ways to Contribute](#ways-to-contribute)
* [Find an Issue](#find-an-issue)
* [Contact Us](#contact-us)
Expand Down Expand Up @@ -35,15 +35,15 @@ We welcome many types of contributions including:
* New end-to-end tests
* Bug fixes
* Documentation
* Issue Triage
* Answering questions on Slack channel
* Issue triage
* Answering questions on our Slack channel
* Web design

Not everything happens through a GitHub pull request.
Please come to our [meetings](#come-to-meetings) or [contact us](#contact-us) and let's discuss how we can work
Please join our [meetings](#join-our-meetings) or [contact us](#contact-us) and let's discuss how we can work
together.

### Come to Meetings
### Join our Meetings

Absolutely everyone is welcome to come to any of our meetings. You never need an
invitation to join us. In fact, we want you to join us, even if you don’t have
Expand All @@ -59,15 +59,15 @@ feedback on others’ ideas, and even sharing your own ideas, and experiences.

### Contact Us

Other than pull requests and GitHub issues, the best way to contact us is to join us at the [CNCF Slack](https://cloud-native.slack.com) under the [**#oras** channel](https://app.slack.com/client/T08PSQ7BQ/CJ1KHJM5Z).
Other than pull requests and GitHub issues, the best way to contact us is to join us at the [CNCF Slack](https://cloud-native.slack.com) under the [**#oras** channel](https://app.slack.com/client/T08PSQ7BQ/CJ1KHJM5Z). You can find the steps in the [community resources](./community_resources.mdx#joining-the-slack-channel).

## Find an Issue

Each ORAS subproject has a label `good-first-issue` for issues that are appropriate for new contributors.
Each ORAS subproject has a label `help-wanted` for issues suitable for someone who is ready to move onto after their first pull request.
For example, for the ORAS CLI project:
* [good first issue](https://github.com/oras-project/oras/labels/good%20first%20issue)
* [help wanted](https://github.com/oras-project/oras/labels/help%20wanted)
* [Good First Issues](https://github.com/oras-project/oras/labels/good%20first%20issue)
* [Help Wanted](https://github.com/oras-project/oras/labels/help%20wanted)

Sometimes there won’t be any issues with these labels. That’s ok! There is
likely still something for you to work on. If you want to contribute, but you
Expand All @@ -84,7 +84,7 @@ Please remember that most contributors and maintainers of the project have respo
* Pull requests will be reviewed by at least two maintainers before being merged.
* If you are submitting a pull request that is a work in progress, mark it as a draft.
* If you have a pull request that is an urgent fix or effects the project widely, bring it up in the Slack channel.
* More details on the [review process](https://github.com/oras-project/community/blob/main/REVIEWING.md)
* More details on the [review process](https://github.com/oras-project/community/blob/main/REVIEWING.md).

## Development Environment Setup

Expand Down
42 changes: 21 additions & 21 deletions docs/community/developer_guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 30
- Git
- Make

## Clone the repository
## Clone the Repository

Once you have the basic tools installed, fork the repository on GitHub and clone it locally:
```bash
Expand All @@ -20,7 +20,7 @@ git clone git@github.com:${MY_GITHUB_NAME}/oras.git
cd oras
```

## Building binary
## Building the Binary

To compile and run the tests, just run the `make` command.
Use `make build` to build all platform binaries to the `bin/` directory.
Expand Down Expand Up @@ -66,43 +66,43 @@ Windows:
make build-windows
```

## Cleaning workspace
## Cleaning Your Workspace

To remove all files not manged by git, run `make clean` (be careful!)

## Managing dependencies
## Managing Dependencies

[Using Go Modules](https://blog.golang.org/using-go-modules) to manage dependencies.

To update or add new dependencies, run `go get <package name>`.

## Release checklist
## Release Checklist

:::info

This section needs a lot of love and automation 🙂

:::

1. Make sure your GPG is available on GitHub at `https://github.com/<username>.gpg`. This can be added at https://github.com/settings/keys
1. If you haven't already, open PR to add your GPG key to the [`KEYS`](https://github.com/oras-project/oras/blob/main/KEYS) file (see file for instructions)
1. Make sure your GPG is available on GitHub at `https://github.com/<username>.gpg`. This can be added at https://github.com/settings/keys.
1. If you haven't already, open PR to add your GPG key to the [`KEYS`](https://github.com/oras-project/oras/blob/main/KEYS) file (see file for instructions).
1. Open a release PR to
- Build with latest golang: replace go version of [binary](https://github.com/oras-project/oras/blob/main/.github/workflows/release-github.yml#L32) and [image](https://github.com/oras-project/oras/blob/main/Dockerfile#L14) to latest stable one
- Update oras version: replace [current stable version](https://github.com/oras-project/oras/blob/main/internal/version/version.go#L20) with upcoming release version
1. After the release PR got merged, [create an issue](https://github.com/oras-project/oras/issues/new) to call for vote on cutting off a release branch named `release-<major>.<minor>` based on the version update commit.
1. Make fresh clone of the repo after all above steps are completed. Create a new tag for the version prefixed with "v" and push the tag directly to the repo.
- Build with the latest golang: replace go version of the [binary](https://github.com/oras-project/oras/blob/main/.github/workflows/release-github.yml#L32) and [image](https://github.com/oras-project/oras/blob/main/Dockerfile#L14) to match the latest stable version.
- Update oras version: replace the [current stable version](https://github.com/oras-project/oras/blob/main/internal/version/version.go#L20) with the upcoming release version.
1. After the release PR gets merged, [create an issue](https://github.com/oras-project/oras/issues/new) to call for a vote cutting off a release branch named `release-<major>.<minor>` based on the version update commit.
1. Make a fresh clone of the repo after all above steps are completed. Create a new tag for the version prefixed with "v" and push the tag directly to the repo.
```sh
version=1.0.0
git tag v${version}
git push origin v${version}
```
1. Wait for GitHub Actions to complete successfully for both the `release-ghcr` and `release-github` pipelines
1. Wait for GitHub Actions to complete successfully for both the `release-ghcr` and `release-github` pipelines.
1. Download all of the artifacts uploaded to the new GitHub release locally (`*checksums.txt`, `*darwin_amd64.tar.gz`, `*linux_armv7.tar.gz`, `*linux_arm64.tar.gz`, `*linux_amd64.tar.gz`, `*windows_amd64.zip`).
1. Verify the checksum of the file, downloaded platform should pass the check:
```sh
shasum -c oras_${version}_checksums.txt
```
1. Run version command and make sure that version number and git commit digest is what you expect it to be (same as the commit used to create the tag). Example:
1. Run `oras version` command and make sure that version number and git commit digest is the expected value (same as the commit used to create the tag). Example:
```sh
mkdir -p oras-bin/
tar -zxf oras_${version}_linux_amd64.tar.gz -C oras-bin
Expand All @@ -115,21 +115,21 @@ This section needs a lot of love and automation 🙂
gpg --armor --detach-sign $file
done
```
1. Validate the signatures. Not that the `KEYS` file should be imported with `gpg --import KEYS`. Run some form of the following (adapted from Linux project):
1. Validate the signatures. Note that the `KEYS` file should be imported with `gpg --import KEYS`. Run some form of the following (adapted from Linux project):
```sh
for file in `ls *.asc`; do
gpg --verify $file
done
```
1. Click "Edit release" button on the release, and add the `.asc` files created in the previous step. Edit the release description for change logs and also add a note indicating your GPG key used to sign the artifacts. Example (replace with your fingerprint etc.):
1. Click the "Edit release" button on the release, and add the `.asc` files created in the previous step. Edit the release description for change logs and also add a note indicating your GPG key used to sign the artifacts. Example (replace with your fingerprint etc.):
```
## Notes

This release was signed with `BE6F A8DD A48D 4C23 0091 A0A9 276D 8A72 4CE1 C704` (@qweeah's GPG key) which can be found [here](https://github.com/qweeah.gpg).
```
1. Click "Publish Release" button to save. Double-check that the release contains a corresponding `.asc` file for each release artifact.
1. Consume beverage of choice.. you're done! Thanks for moving the project forward.
1. Oh yea, tell people about it in `#oras`
1. Oh yea, tell people about it in the `#oras` slack channel.

### Some Comments

Expand All @@ -142,11 +142,11 @@ There is a large number of steps here, mostly manual. Here are some comments and

From a documentation perspective, I would break this down into sections:

1. Prepare the release
2. Cut the release
3. Verify the release (hopefully automated)
4. Sign the release
5. Make available elsewhere (hopefully automated)
1. Prepare the release.
2. Cut the release.
3. Verify the release (hopefully automated).
4. Sign the release.
5. Make available elsewhere (hopefully automated).

Once ready, this should be a doc in the project itself.

Expand Down

0 comments on commit 2ea3ab8

Please sign in to comment.