From 25ea93c933b4c2dd6dfa5284ce0714f3a3b5fa89 Mon Sep 17 00:00:00 2001 From: Phil Pennock Date: Thu, 1 Jul 2021 10:48:30 -0400 Subject: [PATCH] Cleanup references to 'master' and 'gnatsd' (#2336) * We've renamed our default branch from 'master' to 'main' * We switched some time ago from 'gnatsd' to 'nats-server' and some temporary redirects no longer work, so fix those too --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- README.md | 10 ++++----- ROADMAP.md | 36 +++++++++++++++++--------------- 3 files changed, 26 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f52d2aca..2dd0085a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ - [ ] Link to issue, e.g. `Resolves #NNN` - [ ] Documentation added (if applicable) - [ ] Tests added - - [ ] Branch rebased on top of current master (`git pull --rebase origin master`) + - [ ] Branch rebased on top of current main (`git pull --rebase origin main`) - [ ] Changes squashed to a single commit (described [here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)) - [ ] Build is green in Travis CI - - [ ] You have certified that the contribution is your original work and that you license the work to the project under the [Apache 2 license](https://github.com/nats-io/gnatsd/blob/master/LICENSE) + - [ ] You have certified that the contribution is your original work and that you license the work to the project under the [Apache 2 license](https://github.com/nats-io/nats-server/blob/main/LICENSE) Resolves # diff --git a/README.md b/README.md index d0ab9030..db9d596b 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,14 @@ If you are interested in contributing to NATS, read about our... [Docker-Url]: https://hub.docker.com/_/nats [Slack-Image]: https://img.shields.io/badge/chat-on%20slack-green [Slack-Url]: https://join.slack.com/t/natsio/shared_invite/zt-41e6tnmb-qCt63606MKR1YxIHZf4ICA -[Fossa-Url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fnats-io%2Fgnatsd?ref=badge_shield -[Fossa-Image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnats-io%2Fgnatsd.svg?type=shield +[Fossa-Url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fnats-io%2Fnats-server?ref=badge_shield +[Fossa-Image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnats-io%2Fnats-server.svg?type=shield [Build-Status-Url]: https://travis-ci.com/github/nats-io/nats-server -[Build-Status-Image]: https://travis-ci.com/nats-io/nats-server.svg?branch=master +[Build-Status-Image]: https://travis-ci.com/nats-io/nats-server.svg?branch=main [Release-Url]: https://github.com/nats-io/nats-server/releases/tag/v2.3.1 [Release-image]: https://img.shields.io/badge/release-v2.3.1-1eb0fc.svg -[Coverage-Url]: https://coveralls.io/r/nats-io/nats-server?branch=master -[Coverage-image]: https://coveralls.io/repos/github/nats-io/nats-server/badge.svg?branch=master +[Coverage-Url]: https://coveralls.io/r/nats-io/nats-server?branch=main +[Coverage-image]: https://coveralls.io/repos/github/nats-io/nats-server/badge.svg?branch=main [ReportCard-Url]: https://goreportcard.com/report/nats-io/nats-server [ReportCard-Image]: https://goreportcard.com/badge/github.com/nats-io/nats-server [github-release]: https://github.com/nats-io/nats-server/releases/ diff --git a/ROADMAP.md b/ROADMAP.md index 5785bebe..ccf07cce 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -4,18 +4,18 @@ This is the roadmap for the NATS Server. The purpose of this document is to give the major features we plan to implement in the near future. It is a living document, and will change as goals and milestones are completed and new plans are made. -This project's release plan is kept updated on [the wiki](https://github.com/nats-io/gnatsd/wiki). +This project's release plan is kept updated on [the wiki](https://github.com/nats-io/nats-server/wiki). -A master project release plan for all NATS projects can be found +An overall project release plan for all NATS projects can be found [here](https://github.com/nats-io/roadmap/wiki) ### Planning and Tracking -An [Open-Source Planning Process](https://github.com/nats-io/gnatsd/wiki/Open-Source-Planning-Process) is +An [Open-Source Planning Process](https://github.com/nats-io/nats-server/wiki/Open-Source-Planning-Process) is used to define the Roadmap. -This project is managed via GitHub [milestones](https://github.com/nats-io/gnatsd/milestones). -[Project Pages](https://github.com/nats-io/gnatsd/wiki) define the +This project is managed via GitHub [milestones](https://github.com/nats-io/nats-server/milestones). +[Project Pages](https://github.com/nats-io/nats-server/wiki) define the goals for each Milestone and identify current progress. Upcoming features and bugfixes will be added to the relevant milestone. One or more Milestones will @@ -26,17 +26,17 @@ If a feature or bugfix is not part of a milestone, it is currently unscheduled f #### "Hot" configuration reload -We will enable changes to a subset of configuration items on a running `gnatsd` without requiring +We will enable changes to a subset of configuration items on a running `nats-server` without requiring the instance to be restarted. -See [Issue #338](https://github.com/nats-io/gnatsd/issues/338) +See [Issue #338](https://github.com/nats-io/nats-server/issues/338) #### Integrate Promethus support We have done some work recently on exporting NATS monitoring data via Promethus. We plan to share this work in an upcoming release. -See [Issue #345](https://github.com/nats-io/gnatsd/issues/345) +See [Issue #345](https://github.com/nats-io/nats-server/issues/345) ### Further Out @@ -45,7 +45,7 @@ See [Issue #345](https://github.com/nats-io/gnatsd/issues/345) We will improve/extend the auth interface(s) and configuration to support external auth endpoints. -See [Issue #434](https://github.com/nats-io/gnatsd/issues/434) +See [Issue #434](https://github.com/nats-io/nats-server/issues/434) #### Namespace isolation by account/organization @@ -54,14 +54,14 @@ ability to isolate/encapsulate the subject namespace by "tenant" (e.g. an accoun For example, messages published on `FOO.BAR` by tenant A would not be visible to tenant B's subscribers on `FOO.BAR`, and vice versa. We'd like to support this in an efficient and performant way. -See [Issue #347](https://github.com/nats-io/gnatsd/issues/347) and [Issue #348](https://github.com/nats-io/gnatsd/issues/348) +See [Issue #347](https://github.com/nats-io/nats-server/issues/347) and [Issue #348](https://github.com/nats-io/nats-server/issues/348) #### Rate limiting Another multi-tenancy concern is the ability to limit the rate at which publishers can publish messages -to `gnatsd`. We've implemented this in a branch for an internal project but would like to make it public soon. +to `nats-server`. We've implemented this in a branch for an internal project but would like to make it public soon. -See [Issue #346](https://github.com/nats-io/gnatsd/issues/346) +See [Issue #346](https://github.com/nats-io/nats-server/issues/346) #### Make auto-unsubscribe atomic to the SUB protocol @@ -69,16 +69,18 @@ Right now auto-unsubscribe is two operations: `SUB foo 1` followed by `UNSUB foo after 1 message). For the sake of simplicity, efficiency and usability, we'd like to make that an atomic protocol operation, optionally specifying the limit as part of the subscription e.g. `SUB foo 1 1` -See [Issue #344](https://github.com/nats-io/gnatsd/issues/344) +See [Issue #344](https://github.com/nats-io/nats-server/issues/344) #### Rename `gnatsd` to `nats-server` +_Done_ + The original Ruby-based NATS server (now retired) was called `nats-server`, and the newer Go version needed a unique name, hence `gnatsd`. We've recently gone through and attempted to normalize names across all NATS projects to make them more predictable. Renaming `gnatsd` to `nats-server` would align it more closely with the rest of the components in the NATS family. - -See See [Issue #226](https://github.com/nats-io/gnatsd/issues/226) + +See [Issue #226](https://github.com/nats-io/nats-server/issues/226) #### Client pruning/rebalancing @@ -86,6 +88,6 @@ Now that cluster auto-discovery is implemented for both clients and servers, NAT be dynamically expanded on demand. When this happens, it would be useful to (optionally) re-balance the client connections across the new (larger) cluster. - See See [Issue #343](https://github.com/nats-io/gnatsd/issues/343) + See See [Issue #343](https://github.com/nats-io/nats-server/issues/343) + - \ No newline at end of file