Skip to content

Commit 2c13a97

Browse files
authored
Merge pull request #155 from OpenVoxProject/text_changes
Change Puppet -> OpenVox and Bolt -> OpenBolt
2 parents 728806f + 4db7141 commit 2c13a97

File tree

6 files changed

+45
-51
lines changed

6 files changed

+45
-51
lines changed

.github/rulesets.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ rulesets:
1919
2020
!feature
2121
22-
* **Added a new feature** ([#1000](https://github.com/puppetlabs/bolt/issues/1000))
22+
* **Added a new feature** ([#1000](https://github.com/OpenVoxProject/openbolt/issues/1000))
2323
2424
A brief summary of the new feature.

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at conduct@puppet.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at openvox@voxpupuli.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

CONTRIBUTING.md

Lines changed: 30 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,55 @@
11
# Contributing
22

3-
## Bolt Community Slack Channel
3+
## OpenBolt Community Slack Channel
44

5-
Join the `#bolt` channel in the [Puppet community
6-
Slack](https://slack.puppet.com/) where Bolt developers and community members
7-
who use and contribute to Bolt discuss the tool. Another channel of interest is
8-
`#office-hours`, where once a week a Bolt developer leads a Q&A session about
9-
using Bolt.
5+
Join the `#sig-openbolt` channel in the [Vox Pupuli community
6+
Slack](https://voxpupuli.slack.com/) where OpenBolt developers and community members
7+
who use and contribute to OpenBolt discuss the tool.
108

119
## Issues
1210

1311
Please submit new issues on the GitHub issue tracker:
14-
https://github.com/puppetlabs/bolt/issues
12+
https://github.com/OpenVoxProject/openbolt/issues
1513

1614
Choose the appropriate template depending on the kind of issue you're filing:
1715
feature request, bug report, or docs change.
1816

1917
## Types of Improvements
2018

21-
The Bolt ecosystem is extensible via Puppet modules such as those hosted on the
22-
[Forge](https://forge.puppet.com/). Many improvements to the Bolt ecosystem
19+
The OpenBolt ecosystem is extensible via Puppet modules such as those hosted on the
20+
[Forge](https://forge.puppet.com/). Many improvements to the OpenBolt ecosystem
2321
can be added there as new modules, including [Bolt
2422
tasks](https://puppet.com/docs/bolt/latest/writing_tasks.html), [Bolt
2523
plans](https://puppet.com/docs/bolt/latest/writing_yaml_plans.html), [inventory
2624
plugins](https://puppet.com/docs/bolt/latest/writing_plugins.html),
2725
and [Puppet functions](https://puppet.com/docs/puppet/latest/writing_custom_functions.html). Please
28-
consider if your use case can be solved with one of these tools before modifying Bolt itself.
26+
consider if your use case can be solved with one of these tools before modifying OpenBolt itself.
2927

30-
There are certain types of improvements that we believe make sense in Bolt
28+
There are certain types of improvements that we believe make sense in OpenBolt
3129
itself:
3230

3331
* New Transports. The transports API is a work-in-progress, but is something we
3432
aim to stabilize. Currently, transports can't be extended via modules, although
3533
in the future they likely will be.
36-
* Core functionality we believe makes Bolt a better tool, such as the
34+
* Core functionality we believe makes OpenBolt a better tool, such as the
3735
`aggregate` and `canary` plans included in `modules`.
3836
* New core functions
39-
* New functions that use Bolt internals such as the Executor,
37+
* New functions that use OpenBolt internals such as the Executor,
4038
Applicator, or Inventory should live in bolt-modules/boltlib.
41-
* Other directories under bolt-modules are used to categorize Bolt's
39+
* Other directories under bolt-modules are used to categorize OpenBolt's
4240
standard library functions.
4341
* New ways of interacting with plan progress and output, such as prompts to
4442
continue or output processors.
4543

4644
## Pull Requests
4745

48-
Pull requests are welcome on GitHub: https://github.com/puppetlabs/bolt
49-
50-
As with other open-source projects managed by Puppet, you must digitally sign
51-
the Contributor License Agreement before we can accept your pull request:
52-
https://cla.puppet.com
46+
Pull requests are welcome on GitHub: https://github.com/OpenVoxProject/openbolt
5347

5448
**If this is your first time submitting a PR**:
55-
1. Fork the Bolt project (button in the top-right, next to 'star' and 'watch')
56-
1. Clone your fork of Bolt
57-
1. Add the puppetlabs repo as an upstream - `git remote add upstream
58-
git@github.com:puppetlabs/bolt`
49+
1. Fork the OpenBolt project (button in the top-right, next to 'star' and 'watch')
50+
1. Clone your fork of OpenBolt
51+
1. Add the OpenVoxProject repo as an upstream - `git remote add upstream
52+
git@github.com:openvoxproject/openbolt`
5953
1. Make a new branch off of main - `git checkout -b mybranchname`
6054
1. Commit your changes and add a useful commit message, including what
6155
specifically you changed and why - `git commit`
@@ -75,7 +69,7 @@ https://cla.puppet.com
7569
```
7670
1. Push your changes to your branch on your fork - `git push origin
7771
mybranchname`
78-
1. Open a PR against main at https://github.com/puppetlabs/bolt
72+
1. Open a PR against main at https://github.com/OpenVoxProject/openbolt
7973
1. Ensure tests pass
8074
8175
**If it's not your first PR:**
@@ -87,45 +81,45 @@ https://cla.puppet.com
8781
specifically you changed and why - `git commit`
8882
1. Push your changes to your branch on your fork - `git push origin
8983
mybranchname`
90-
1. Open a PR against main at https://github.com/puppetlabs/bolt
84+
1. Open a PR against main at https://github.com/OpenVoxProject/openbolt
9185
92-
Once you've opened a PR the Bolt team will automatically be notified. We're a small team, but we do
86+
Once you've opened a PR the Vox Pupuli OpenBolt team will automatically be notified. We're a small team, but we do
9387
our best to review PRs in a timely manner.
9488
95-
## Installing Bolt
89+
## Installing OpenBolt
9690
97-
If you are interested in trying Bolt out or using it in production, we recommend
91+
If you are interested in trying OpenBolt out or using it in production, we recommend
9892
installing from a system package detailed in [Installing
9993
Bolt](https://puppet.com/docs/bolt/latest/bolt_installing.html). The following
10094
installation instructions are focused on developers who wish to contribute to
101-
Bolt.
95+
OpenBolt.
10296
103-
Depending on your development workflow, you can install Bolt one of three ways:
97+
Depending on your development workflow, you can install OpenBolt one of three ways:
10498
10599
* From [RubyGems](https://rubygems.org)
106100
* From your Gemfile with Bundler
107101
* From source
108102
109-
Bolt vendors a version of Puppet that supports executing tasks and plans, so you
110-
do not need to install Puppet. If you happen to already have Puppet installed,
103+
OpenBolt vendors a version of OpenVox that supports executing tasks and plans, so you
104+
do not need to install OpenVox or Puppet. If you happen to already have OpenVox or Puppet installed,
111105
then the vendored version takes precedence and does not conflict with the
112106
already installed version.
113107
114108
### RubyGems install
115109
116110
To install from [RubyGems](https://rubygems.org), run:
117111
118-
gem install bolt
112+
gem install openbolt
119113
120114
### Bundler install
121115
122116
To use [Bundler](https://bundler.io), add this to your Gemfile:
123117
124-
gem 'bolt'
118+
gem 'openbolt'
125119
126-
### Run Bolt from source
120+
### Run OpenBolt from source
127121
128-
To run Bolt from source:
122+
To run OpenBolt from source:
129123
130124
bundle install --path .bundle --without test
131125
bundle exec bolt ...

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ if File.exist? local_gemfile
3434
eval_gemfile local_gemfile
3535
end
3636

37-
# https://github.com/OpenVoxProject/puppet/issues/90
37+
# https://github.com/OpenVoxProject/openvox/issues/90
3838
gem 'syslog', '~> 0.3' if RUBY_VERSION >= '3.4'
3939

4040
gem 'puppet_metadata', '~> 5.3'

acceptance/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@
2323

2424
## Description
2525

26-
This acceptance suite allows you to test bolt using the following methods:
26+
This acceptance suite allows you to test OpenBolt using the following methods:
2727

28-
* gem: Install bolt via gem from a gemsource defined as an environment
28+
* gem: Install OpenBolt via gem from a gemsource defined as an environment
2929
variable (defaults to https://gems.rubygems.org).
30-
* git: Install bolt via the git repo from a branch or SHA defined as
30+
* git: Install OpenBolt via the git repo from a branch or SHA defined as
3131
environment variables (defaults to #main/HEAD).
32-
* package: Install bolt via the puppet repos
32+
* package: Install OpenBolt via the openvox repos
3333

3434
The tests assume the following [Beaker
35-
roles](https://github.com/puppetlabs/beaker/blob/master/docs/concepts/roles_what_are_they.md) be assigned to your SUT nodes:
35+
roles](https://github.com/voxpupuli/beaker/blob/master/docs/concepts/roles_what_are_they.md) be assigned to your SUT nodes:
3636
* `bolt`: This role defines the node that will act as the `bolt`
3737
controller node. There should be only one `bolt` node defined in a
3838
given Beaker hosts file.
@@ -42,7 +42,7 @@ roles](https://github.com/puppetlabs/beaker/blob/master/docs/concepts/roles_what
4242
connection protocol. Any number of nodes can be defined with this role.
4343

4444
You might also need to specify nodes for
45-
[beaker-hostgenerator](https://github.com/puppetlabs/beaker-hostgenerator) to
45+
[beaker-hostgenerator](https://github.com/voxpupuli/beaker-hostgenerator) to
4646
use to test bolt on. You can see all of the available
4747
operatingsystem-architecture nodes by running
4848
```
@@ -78,16 +78,16 @@ Setup will update passwords on targets to match this value after connecting via
7878
**BOLT_CONTOLLER** (Default `centos7-64bolt`): Operating system and
7979
architecture to be used for the node running `bolt`. This value should be one
8080
of the OS-architecture strings used by
81-
[beaker-hostgenerator](https://github.com/puppetlabs/beaker-hostgenerator)
81+
[beaker-hostgenerator](https://github.com/voxpupuli/beaker-hostgenerator)
8282
(i.e.`windows10ent-64`). See the [beaker-hostgenerator
83-
usage](https://github.com/puppetlabs/beaker-hostgenerator#usage) for more
83+
usage](https://github.com/voxpupuli/beaker-hostgenerator#usage) for more
8484
information about formatting, and see the [examples](#examples) below for
8585
examples.
8686

8787
**BOLT_NODES** (Default `ubuntu1604-64,osx1012-64,windows10ent-64`):
8888
Operating system and architecture to be used for the nodes targeted by the
8989
bolt tests. This value should be expressed in the notation used by
90-
[beaker-hostgenerator](https://github.com/puppetlabs/beaker-hostgenerator#usage).
90+
[beaker-hostgenerator](https://github.com/voxpupuli/beaker-hostgenerator#usage).
9191
Multiples should be hyphen separated. See [examples](#examples) below for
9292
examples.
9393

@@ -192,14 +192,14 @@ bundle exec rake test:gem
192192

193193
#### Git
194194

195-
Example to test latest git commit to main on https://github.com/puppetlabs/bolt
195+
Example to test latest git commit to main on https://github.com/OpenVoxProject/openbolt
196196
```
197197
SSH_PASSWORD='S3@ret3' \
198198
WINRM_PASSWORD='S3@ret3' \
199199
bundle exec rake test:git
200200
```
201201

202-
Example to test specific SHA on https://github.com/puppetlabs/bolt
202+
Example to test specific SHA on https://github.com/OpenVoxProject/openbolt
203203
```
204204
GIT_SHA=309e197 \
205205
SSH_PASSWORD='S3@ret3' \

acceptance/lib/acceptance/bolt_setup_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def git_server
3131
end
3232

3333
def git_fork
34-
ENV['GIT_FORK'] || 'puppetlabs/bolt'
34+
ENV['GIT_FORK'] || 'OpenVoxProject/openbolt'
3535
end
3636

3737
def git_branch

0 commit comments

Comments
 (0)