Update default branch to main
This commit is contained in:
parent
22795b161b
commit
336001ac17
@ -16,5 +16,5 @@ wrap gem build *.gemspec \
|
||||
g=(vagrant*.gem)
|
||||
gem=$(printf "%s" "${g}")
|
||||
|
||||
wrap aws s3 cp "${gem}" "${ASSETS_PRIVATE_BUCKET}/${repository}/vagrant-master.gem" \
|
||||
"Failed to store Vagrant RubyGem master build"
|
||||
wrap aws s3 cp "${gem}" "${ASSETS_PRIVATE_BUCKET}/${repository}/vagrant-main.gem" \
|
||||
"Failed to store Vagrant RubyGem main build"
|
||||
|
||||
@ -39,7 +39,7 @@ vagrant_version="${vagrant_version##*version: }"
|
||||
# update the repository variable with the desired destination
|
||||
repo_owner="${target_owner}"
|
||||
repo_name="${target_repository}"
|
||||
full_sha="master"
|
||||
full_sha="main"
|
||||
|
||||
export GITHUB_TOKEN="${HASHIBOT_TOKEN}"
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ workflows:
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- main
|
||||
algolia_index:
|
||||
jobs:
|
||||
- algolia-index:
|
||||
|
||||
10
.github/CONTRIBUTING.md
vendored
10
.github/CONTRIBUTING.md
vendored
@ -12,7 +12,7 @@ To ensure that the Vagrant community remains an open and safe space for everyone
|
||||
|
||||
### Reporting an Issue
|
||||
|
||||
**Tip:** We have provided a [GitHub issue template](https://github.com/hashicorp/vagrant/blob/master/.github/ISSUE_TEMPLATE/bug-report.md). By respecting the proposed format and filling all the relevant sections, you'll strongly help the Vagrant collaborators to handle your request the best possible way.
|
||||
**Tip:** We have provided a [GitHub issue template](https://github.com/hashicorp/vagrant/blob/main/.github/ISSUE_TEMPLATE/bug-report.md). By respecting the proposed format and filling all the relevant sections, you'll strongly help the Vagrant collaborators to handle your request the best possible way.
|
||||
|
||||
### Issue Lifecycle
|
||||
|
||||
@ -70,9 +70,9 @@ You can now run Vagrant by running `bundle exec vagrant` from inside that direct
|
||||
Once you're confident that your upcoming changes will be accepted:
|
||||
|
||||
* In your forked repository, create a topic branch for your upcoming patch.
|
||||
* Usually this is based on the master branch.
|
||||
* Checkout a new branch based on master; `git checkout -b my-contrib master`
|
||||
Please avoid working directly on the `master` branch.
|
||||
* Usually this is based on the main branch.
|
||||
* Checkout a new branch based on main; `git checkout -b my-contrib main`
|
||||
Please avoid working directly on the `main` branch.
|
||||
* Make focused commits of logical units and describe them properly.
|
||||
* Avoid re-formatting of the existing code.
|
||||
* Check for unnecessary whitespace with `git diff --check` before committing.
|
||||
@ -125,7 +125,7 @@ $ rake acceptance:run COMPONENTS="cli"
|
||||
### Submit Changes
|
||||
|
||||
* Push your changes to a topic branch in your fork of the repository.
|
||||
* Open a PR to the original repository and choose the right original branch you want to patch (master for most cases).
|
||||
* Open a PR to the original repository and choose the right original branch you want to patch (main for most cases).
|
||||
* If not done in commit messages (which you really should do) please reference and update your issue with the code changes.
|
||||
* Even if you have write access to the repository, do not directly push or merge your own pull requests. Let another team member review your PR and approve.
|
||||
|
||||
|
||||
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
@ -1,7 +1,7 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
paths-ignore:
|
||||
- 'CHANGELOG.md'
|
||||
- 'website/**'
|
||||
|
||||
2
.github/workflows/code.yml
vendored
2
.github/workflows/code.yml
vendored
@ -1,7 +1,7 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'master'
|
||||
- 'main'
|
||||
- 'spec-test-*'
|
||||
|
||||
jobs:
|
||||
|
||||
2
.github/workflows/spectesting.yml
vendored
2
.github/workflows/spectesting.yml
vendored
@ -1,7 +1,7 @@
|
||||
on:
|
||||
workflow_dispatch:
|
||||
branches:
|
||||
- 'master'
|
||||
- 'main'
|
||||
repository_dispatch:
|
||||
types: [prerelease]
|
||||
|
||||
|
||||
4
.github/workflows/testing.yml
vendored
4
.github/workflows/testing.yml
vendored
@ -1,7 +1,7 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
- 'test-*'
|
||||
paths:
|
||||
- 'bin/**'
|
||||
@ -10,7 +10,7 @@ on:
|
||||
- 'test/**'
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
paths:
|
||||
- 'bin/**'
|
||||
- 'lib/**'
|
||||
|
||||
@ -45,11 +45,11 @@ To learn how to build a fully functional development environment, follow the
|
||||
|
||||
## Installing from Source
|
||||
|
||||
If you want the bleeding edge version of Vagrant, we try to keep master pretty stable
|
||||
If you want the bleeding edge version of Vagrant, we try to keep main pretty stable
|
||||
and you're welcome to give it a shot. Please review the installation page [here](https://www.vagrantup.com/docs/installation/source).
|
||||
|
||||
## Contributing to Vagrant
|
||||
|
||||
Please take time to read the [HashiCorp Community Guidelines](https://www.hashicorp.com/community-guidelines) and the [Vagrant Contributing Guide](https://github.com/hashicorp/vagrant/blob/master/.github/CONTRIBUTING.md).
|
||||
Please take time to read the [HashiCorp Community Guidelines](https://www.hashicorp.com/community-guidelines) and the [Vagrant Contributing Guide](https://github.com/hashicorp/vagrant/blob/main/.github/CONTRIBUTING.md).
|
||||
|
||||
Then you're good to go!
|
||||
|
||||
@ -22,7 +22,7 @@ targeted at Vagrant core members who have the ability to cut a release.
|
||||
to the latest version, commit, and push.
|
||||
|
||||
1. Publish the webiste by deleting the `stable-website` branch, recreate the branch,
|
||||
and force push. From the `master` branch, run:
|
||||
and force push. From the `main` branch, run:
|
||||
|
||||
```
|
||||
$ git branch -D stable-website
|
||||
|
||||
@ -34,7 +34,7 @@ git add .
|
||||
git commit -q -m "Deploy by $USER"
|
||||
|
||||
git remote add heroku git@heroku.com:vagrantup-docs-2.git
|
||||
git push -f heroku master
|
||||
git push -f heroku main
|
||||
|
||||
# Cleanup the deploy
|
||||
rm -rf $DEPLOY
|
||||
|
||||
@ -34,7 +34,7 @@ git add .
|
||||
git commit -q -m "Deploy by $USER"
|
||||
|
||||
git remote add heroku git@heroku.com:vagrantup-www-2.git
|
||||
git push -f heroku master
|
||||
git push -f heroku main
|
||||
|
||||
# Cleanup the deploy
|
||||
rm -rf $DEPLOY
|
||||
|
||||
@ -35,7 +35,7 @@ function DocsLayoutWrapper(pageMeta) {
|
||||
disableFilter: true,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/main/website/pages/${pageMeta.__resourcePath}`}
|
||||
>
|
||||
<SearchProvider>
|
||||
<SearchBar />
|
||||
|
||||
@ -22,7 +22,7 @@ function DefaultLayoutWrapper(pageMeta) {
|
||||
order: [],
|
||||
disableFilter: true,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/main/website/pages/${pageMeta.__resourcePath}`}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
@ -31,7 +31,7 @@ function IntroLayoutWrapper(pageMeta) {
|
||||
disableFilter: true,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/main/website/pages/${pageMeta.__resourcePath}`}
|
||||
>
|
||||
<SearchProvider>
|
||||
<SearchBar />
|
||||
|
||||
@ -31,7 +31,7 @@ function CloudLayoutWrapper(pageMeta) {
|
||||
disableFilter: true,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/main/website/pages/${pageMeta.__resourcePath}`}
|
||||
>
|
||||
<SearchProvider>
|
||||
<SearchBar />
|
||||
|
||||
@ -27,7 +27,7 @@ function VMWareLayoutWrapper(pageMeta) {
|
||||
data,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/main/website/pages/${pageMeta.__resourcePath}`}
|
||||
/>
|
||||
</MDXProvider>
|
||||
)
|
||||
|
||||
@ -116,7 +116,7 @@ users, passwords, private keys, etc.).
|
||||
|
||||
By default, Vagrant expects a "vagrant" user to SSH into the machine as.
|
||||
This user should be setup with the
|
||||
[insecure keypair](https://github.com/hashicorp/vagrant/tree/master/keys)
|
||||
[insecure keypair](https://github.com/hashicorp/vagrant/tree/main/keys)
|
||||
that Vagrant uses as a default to attempt to SSH. Also, even though
|
||||
Vagrant uses key-based authentication by default, it is a general convention
|
||||
to set the password for the "vagrant" user to "vagrant". This lets people
|
||||
|
||||
@ -163,7 +163,7 @@ should be considered bugs.
|
||||
|
||||
Therefore, to fit into Vagrant's error handling mechanisms, subclass
|
||||
`VagrantError` and set a proper message on your exception. To see
|
||||
examples of this, look at Vagrant's [built-in errors](https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/errors.rb).
|
||||
examples of this, look at Vagrant's [built-in errors](https://github.com/hashicorp/vagrant/blob/main/lib/vagrant/errors.rb).
|
||||
|
||||
## Console Input and Output
|
||||
|
||||
@ -175,5 +175,5 @@ pipes are closed, there is no input pipe, etc.
|
||||
|
||||
A UI object is available on every `Vagrant::Environment` via the `ui` property
|
||||
and is exposed within every middleware environment via the `:ui` key. UI
|
||||
objects have [decent documentation](https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/ui.rb)
|
||||
objects have [decent documentation](https://github.com/hashicorp/vagrant/blob/main/lib/vagrant/ui.rb)
|
||||
within the comments of their source.
|
||||
|
||||
@ -19,7 +19,7 @@ _plugins_.
|
||||
Plugins are powerful, first-class citizens that extend Vagrant using a
|
||||
well-documented, stable API that can withstand major version upgrades.
|
||||
|
||||
In fact, most of the core of Vagrant is [implemented using plugins](https://github.com/hashicorp/vagrant/tree/master/plugins).
|
||||
In fact, most of the core of Vagrant is [implemented using plugins](https://github.com/hashicorp/vagrant/tree/main/plugins).
|
||||
Since Vagrant [dogfoods](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) its own
|
||||
plugin API, you can be confident that the interface is stable and well supported.
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@ The provider class should subclass and implement
|
||||
return the proper parent class.
|
||||
|
||||
This class and the methods that need to be implemented are
|
||||
[very well documented](https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/plugin/v2/provider.rb). The documentation done on the class in the comments should be
|
||||
[very well documented](https://github.com/hashicorp/vagrant/blob/main/lib/vagrant/plugin/v2/provider.rb). The documentation done on the class in the comments should be
|
||||
enough to understand what needs to be done.
|
||||
|
||||
Viewing the [AWS provider class](https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/provider.rb) as well as the
|
||||
@ -125,12 +125,12 @@ a friendly error, so do not worry if you miss any, things will not explode
|
||||
or crash spectacularly.
|
||||
|
||||
Take a look at how the VirtualBox provider
|
||||
[uses actions to build up complicated multi-step processes](https://github.com/hashicorp/vagrant/blob/master/plugins/providers/virtualbox/action.rb#L287). The AWS provider [uses a similar process](https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/action.rb).
|
||||
[uses actions to build up complicated multi-step processes](https://github.com/hashicorp/vagrant/blob/main/plugins/providers/virtualbox/action.rb#L287). The AWS provider [uses a similar process](https://github.com/mitchellh/vagrant-aws/blob/master/lib/vagrant-aws/action.rb).
|
||||
|
||||
## Built-in Middleware
|
||||
|
||||
To assist with common tasks, Vagrant ships with a set of
|
||||
[built-in middleware](https://github.com/hashicorp/vagrant/tree/master/lib/vagrant/action/builtin). Each of the middleware is well commented on the behavior and options
|
||||
[built-in middleware](https://github.com/hashicorp/vagrant/tree/main/lib/vagrant/action/builtin). Each of the middleware is well commented on the behavior and options
|
||||
for each, and using these built-in middleware is critical to building
|
||||
a well-behaved provider.
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ The provisioner class should subclass and implement
|
||||
Vagrant return the proper parent class for provisioners.
|
||||
|
||||
This class and the methods that need to be implemented are
|
||||
[very well documented](https://github.com/hashicorp/vagrant/blob/master/lib/vagrant/plugin/v2/provisioner.rb).
|
||||
[very well documented](https://github.com/hashicorp/vagrant/blob/main/lib/vagrant/plugin/v2/provisioner.rb).
|
||||
The documentation on the class in the comments should be enough
|
||||
to understand what needs to be done.
|
||||
|
||||
@ -58,7 +58,7 @@ There are two main methods that need to be implemented: the
|
||||
The `configure` method is called early in the machine booting process
|
||||
to allow the provisioner to define new configuration on the machine, such
|
||||
as sharing folders, defining networks, etc. As an example, the
|
||||
[Chef solo provisioner](https://github.com/hashicorp/vagrant/blob/master/plugins/provisioners/chef/provisioner/chef_solo.rb#L24)
|
||||
[Chef solo provisioner](https://github.com/hashicorp/vagrant/blob/main/plugins/provisioners/chef/provisioner/chef_solo.rb#L24)
|
||||
uses this to define shared folders.
|
||||
|
||||
The `provision` method is called when the machine is booted and ready
|
||||
|
||||
@ -96,7 +96,7 @@ you only have the overhead of one virtual machine, and only if it is
|
||||
absolutely necessary.
|
||||
|
||||
By default, the host VM Vagrant spins up is
|
||||
[backed by boot2docker](https://github.com/hashicorp/vagrant/blob/master/plugins/providers/docker/hostmachine/Vagrantfile),
|
||||
[backed by boot2docker](https://github.com/hashicorp/vagrant/blob/main/plugins/providers/docker/hostmachine/Vagrantfile),
|
||||
because it launches quickly and uses little resources. But the host VM
|
||||
can be customized to point to _any_ Vagrantfile. This allows the host VM
|
||||
to more closely match production by running a VM running Ubuntu, RHEL,
|
||||
|
||||
@ -107,7 +107,7 @@ a bare minimum:
|
||||
|
||||
- SSH server with key-based authentication setup. If you want the box to
|
||||
work with default Vagrant settings, the SSH user must be set to accept
|
||||
the [insecure keypair](https://github.com/hashicorp/vagrant/blob/master/keys/vagrant.pub)
|
||||
the [insecure keypair](https://github.com/hashicorp/vagrant/blob/main/keys/vagrant.pub)
|
||||
that ships with Vagrant.
|
||||
|
||||
- [VMware Tools](https://kb.vmware.com/kb/340) so that things such as shared
|
||||
|
||||
@ -38,7 +38,7 @@ in order to setup a development environment.
|
||||
|
||||
## Submitting your first pull request
|
||||
|
||||
Check out the [Vagrant contribution guide](https://github.com/hashicorp/vagrant/blob/master/.github/CONTRIBUTING.md)
|
||||
Check out the [Vagrant contribution guide](https://github.com/hashicorp/vagrant/blob/main/.github/CONTRIBUTING.md)
|
||||
for instructions on what can be expected for the pull request lifecycle.
|
||||
|
||||
When submitting your changes, please ensure you have done the following:
|
||||
|
||||
@ -34,7 +34,7 @@ it provides, there may be information lacking in the documentation.
|
||||
Vagrant Cloud documentation is open source.
|
||||
If you'd like to improve or correct the documentation,
|
||||
please submit a pull-request to the
|
||||
[Vagrant project on GitHub](https://github.com/hashicorp/vagrant/tree/master/website/pages/docs/vagrant-cloud/).
|
||||
[Vagrant project on GitHub](https://github.com/hashicorp/vagrant/tree/main/website/pages/docs/vagrant-cloud/).
|
||||
The Vagrant Cloud documentation can be found in the `/website/pages/vagrant-cloud/` directory.
|
||||
|
||||
Otherwise, to make a suggestion or report an error in documentation, please
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user