From 9fe1e0e9b6ec3ef19c7c6e16b35b76398c663e64 Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Wed, 17 Nov 2021 00:22:27 +0000 Subject: [PATCH] fix links Signed-off-by: Doug Davis --- README.md | 34 +++++++++++++------------- community/GOVERNANCE.md | 4 +-- community/SDK-PR-guidelines.md | 20 +++++++-------- community/SDK-maintainer-guidelines.md | 6 ++--- roadmap.md | 2 +- 5 files changed, 33 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index e08e8dd52..a017c2f4e 100644 --- a/README.md +++ b/README.md @@ -27,26 +27,26 @@ The following documents are available: | | Latest Release | Working Draft | | :---------------------------- | :-----------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | | **Core Specification:** | -| CloudEvents | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/spec.md) | +| CloudEvents | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md) | | | | **Optional Specifications:** | -| AMQP Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/amqp-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/amqp-protocol-binding.md) | -| AVRO Event Format | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/avro-format.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/formats/avro-format.md) | -| HTTP Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/http-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/http-protocol-binding.md) | -| JSON Event Format | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/formats/json-format.md) | -| Kafka Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/kafka-protocol-binding.md) | -| MQTT Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/mqtt-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/mqtt-protocol-binding.md) | -| NATS Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/nats-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/nats-protocol-binding.md) | -| WebSockets Protocol Binding | - | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/bindings/websockets-protocol-binding.md) | -| Protobuf Event Format | | [v1.0-rc1](https://github.com/cloudevents/spec/blob/master/cloudevents/formats/protobuf-format.md) | -| Web hook | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/http-webhook.md) | +| AMQP Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/amqp-protocol-binding.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/amqp-protocol-binding.md) | +| AVRO Event Format | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/avro-format.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/formats/avro-format.md) | +| HTTP Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/http-protocol-binding.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/http-protocol-binding.md) | +| JSON Event Format | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/json-format.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/formats/json-format.md) | +| Kafka Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/kafka-protocol-binding.md) | +| MQTT Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/mqtt-protocol-binding.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/mqtt-protocol-binding.md) | +| NATS Protocol Binding | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/nats-protocol-binding.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/nats-protocol-binding.md) | +| WebSockets Protocol Binding | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/websockets-protocol-binding.md) | +| Protobuf Event Format | | [v1.0-rc1](https://github.com/cloudevents/spec/blob/main/cloudevents/formats/protobuf-format.md) | +| Web hook | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/http-webhook.md) | | | | **Additional Documentation:** | -| CloudEvents Adapters | - | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/adapters.md) | -| CloudEvents SDK Requirements | - | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/SDK.md) | -| Documented Extensions | - | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/documented-extensions.md) | -| Primer | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/primer.md) | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/primer.md) | -| Proprietary Specifications | - | [master](https://github.com/cloudevents/spec/blob/master/cloudevents/proprietary-specs.md) | +| CloudEvents Adapters | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/adapters.md) | +| CloudEvents SDK Requirements | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/SDK.md) | +| Documented Extensions | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/documented-extensions.md) | +| Primer | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/primer.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/primer.md) | +| Proprietary Specifications | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/proprietary-specs.md) | If you are new to CloudEvents, it is recommended that you start by reading the [Primer](primer.md) for an overview of the specification's goals and design @@ -55,7 +55,7 @@ decisions, and then move on to the [core specification](spec.md). Since not all event producers generate CloudEvents by default, there is documentation describing the recommended process for adapting some popular events into CloudEvents, see -[CloudEvents Adapters](https://github.com/cloudevents/spec/blob/master/cloudevents/adapters.md). +[CloudEvents Adapters](https://github.com/cloudevents/spec/blob/main/cloudevents/adapters.md). ## SDKs diff --git a/community/GOVERNANCE.md b/community/GOVERNANCE.md index 2d608fe4c..ed2bec4d3 100644 --- a/community/GOVERNANCE.md +++ b/community/GOVERNANCE.md @@ -151,12 +151,12 @@ To create a new release: - Merge the PR. - Create a [new release](https://github.com/cloudevents/spec/releases/new): - Choose a "Tag version" of the form: `vX.Y`, e.g. `v0.1` - - Target should be `master`, the default value + - Target should be `main`, the default value - Release title should be the same as the Tag - `vX.Y` - Add some descriptive text, or the list of PRs that have been merged since the previous release. The git query to get the list commits since the last release is: - `git log --pretty=format:%s master...v0.1 | grep -v "Merge pull"`. + `git log --pretty=format:%s main...v0.1 | grep -v "Merge pull"`. Just replace "v0.1" with the name of the previous release. - Press `Publish release` button - Create a PR that modifies the version string in all of the files diff --git a/community/SDK-PR-guidelines.md b/community/SDK-PR-guidelines.md index 5a2dfd2c4..38f5d63e9 100644 --- a/community/SDK-PR-guidelines.md +++ b/community/SDK-PR-guidelines.md @@ -8,7 +8,7 @@ your code. Thanks for getting involved! :rocket: * [Getting Started](#getting-started) * [Branches](#branches) * [Commit Messages](#commit-messages) -* [Staying current with master](#staying-current-with-master) +* [Staying current with main](#staying-current-with-main) * [Submitting and Updating a Pull Request](#submitting-and-updating-your-pull-request) * [Congratulations!](#congratulations) @@ -34,7 +34,7 @@ you might create a branch named `48-fix-http-agent-error`. ```console git fetch upstream -git reset --hard upstream/master +git reset --hard upstream/main git checkout FETCH_HEAD git checkout -b 48-fix-http-agent-error ``` @@ -89,19 +89,19 @@ Date: Thu Feb 2 11:41:15 2018 -0800 Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will be rejected by the automated DCO check. -## Staying Current with `master` +## Staying Current with `main` -As you are working on your branch, changes may happen on `master`. Before +As you are working on your branch, changes may happen on `main`. Before submitting your pull request, be sure that your branch has been updated with the latest commits. ```console git fetch upstream -git rebase upstream/master +git rebase upstream/main ``` This may cause conflicts if the files you are changing on your branch are -also changed on master. Error messages from `git` will indicate if conflicts +also changed on main. Error messages from `git` will indicate if conflicts exist and what files need attention. Resolve the conflicts in each file, then continue with the rebase with `git rebase --continue`. @@ -117,15 +117,15 @@ git push -f origin 48-fix-http-agent-error Before submitting a pull request, you should make sure that all of the tests successfully pass. -Once you have sent your pull request, `master` may continue to evolve -before your pull request has landed. If there are any commits on `master` +Once you have sent your pull request, `main` may continue to evolve +before your pull request has landed. If there are any commits on `main` that conflict with your changes, you may need to update your branch with these changes before the pull request can land. Resolve conflicts the same way as before. ```console git fetch upstream -git rebase upstream/master +git rebase upstream/main # fix any potential conflicts git push -f origin 48-fix-http-agent-error ``` @@ -142,7 +142,7 @@ for details. ```console git commit -m "fixup: fix typo" -git rebase -i upstream/master # follow git instructions +git rebase -i upstream/main # follow git instructions ``` Once you have rebased your commits, you can force push to your fork as before. diff --git a/community/SDK-maintainer-guidelines.md b/community/SDK-maintainer-guidelines.md index a21906785..ac0a79852 100644 --- a/community/SDK-maintainer-guidelines.md +++ b/community/SDK-maintainer-guidelines.md @@ -68,15 +68,15 @@ Here are some guidelines arround pull request approvals and timing. ## Branch Management -The `master` branch is the bleeding edge. New major versions of the library +The `main` branch is the bleeding edge. New major versions of the library are cut from this branch and tagged. If you intend to submit a pull request -you should use `master HEAD` as your starting point. +you should use `main HEAD` as your starting point. Each major release should result in a new branch and tag. For example, the release of version 1.0.0 of the library will result in a `v1.0.0` tag on the release commit, and a new branch `v1.x.y` for subsequent minor and patch level releases of that major version. However, development will continue -apace on `master` for the next major version - e.g. 2.0.0. Version branches +apace on `main` for the next major version - e.g. 2.0.0. Version branches are only created for each major version. Minor and patch level releases are simply tagged. diff --git a/roadmap.md b/roadmap.md index e3e0f9e7a..3fd8e0ffa 100644 --- a/roadmap.md +++ b/roadmap.md @@ -38,7 +38,7 @@ _0.1_ - Completed - 2018/04/20 1. Interoperability demo. 1. At least one open source implementation of sending and receiving events, see - [community open source](https://github.com/cloudevents/spec/blob/master/community/open-source.md). + [community open source](https://github.com/cloudevents/spec/blob/main/community/open-source.md). 1. Events are sent by code written by Developer1 and received by code written by Developer2, where Developer1 has no knowledge of Developer2.