Skip to content

Commit

Permalink
chore: new name
Browse files Browse the repository at this point in the history
  • Loading branch information
gforcada committed Dec 23, 2024
1 parent ce8d74c commit 627837d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ As seen above, [`tox`](https://pypi.org/project/tox) provides the answers.

Tooling is like fashion, it keeps evolving and changing.

The great power behind `plone/meta` is that when we implement a better solution or tool,
The great power behind `plone.meta` is that when we implement a better solution or tool,
we can swiftly move all packages to the new approach, making it as painless as possible!

## Configure a package
Expand Down
28 changes: 14 additions & 14 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ to adapt the repository just configured!

## Configuration files

In a nutshell `plone/meta`, puts some configuration files on the repository.
In a nutshell `plone.meta`, puts some configuration files on the repository.

Currently the files managed by `plone/meta` are the following.
Currently the files managed by `plone.meta` are the following.

- `.meta.toml`: `plone/meta`'s configuration file
- `.meta.toml`: `plone.meta`'s configuration file
- `.editorconfig`: configuration meant to be read by code editors
- `.flake8`: [`flake8`](https://pypi.org/project/flake8) configuration
- `.gitignore`: list of file/folders patterns that `git` should ignore
Expand All @@ -37,7 +37,7 @@ Currently the files managed by `plone/meta` are the following.
- `tox.ini`: [`tox`](https://pypi.org/project/tox) configuration, __the most important file__

You can find the _template_ files for each of these files
in the `config/default` folder of this `plone/meta` repository.
in the `config/default` folder of this `plone.meta` repository.

You will notice that they have a `.jinja` extension.
That's because the files are not merely copied over to the target repository,
Expand All @@ -49,29 +49,29 @@ See the next section about how to extend and modify these configuration files.

It is one thing to standardize, yet another to be flexible enough to adapt to each repository's particular needs.

Fortunately `plone/meta` tries its best to accomplish both:
Fortunately `plone.meta` tries its best to accomplish both:

- it provides sane defaults
- it allows extension of the defaults with custom configuration

The files mentioned above have comments all over them
with instructions on how to extend, modify, and influence
what `plone/meta` ends up adding on those files.
what `plone.meta` ends up adding on those files.

Those options are to be stored,
as it is mentioned on the comments themselves,
in `.meta.toml`.

This way, when the configuration files get regenerated,
`plone/meta` reads the configuration in `.meta.toml`
`plone.meta` reads the configuration in `.meta.toml`
and reapplies the specific configuration on the other files.

See the specific configuration files sections below on how to extend and modify each configuration file.

### Configuration philosophy

The idea behind the configuration system
in `plone/meta` controlled configuration files is to make it as simple as possible.
in `plone.meta` controlled configuration files is to make it as simple as possible.

Rather than adding plenty of configuration options,
almost all configuration files have an `extra_lines` section
Expand All @@ -85,7 +85,7 @@ where the simple approach described above is not enough.
### More configuration options

Please use the [issue tracker](https://github.com/plone/meta/issues/new)
to ask for more extension points whenever `plone/meta`
to ask for more extension points whenever `plone.meta`
does not fulfill all your needs.

### Applying a customized configuration
Expand Down Expand Up @@ -173,7 +173,7 @@ jobs = [
]
```

It is possible to configure from which branch/tag of `plone/meta`
It is possible to configure from which branch/tag of `plone.meta`
to get the workflow files by setting the value of the `ref` key:

```toml
Expand Down Expand Up @@ -406,7 +406,7 @@ _custom configuration_

#### `towncrier` configuration:

If your project contains a `news/` folder, `plone/meta` will add
If your project contains a `news/` folder, `plone.meta` will add
the configuration for `towncrier`.

If your `CHANGES` file has the extension `.md`, a `changelog_template.jinja`
Expand All @@ -432,7 +432,7 @@ _custom configuration_
### `tox.ini`

Depending on the test runner that you want to use,
`plone/meta` will adapt `tox.ini` to it.
`plone.meta` will adapt `tox.ini` to it.

In the `[tox]` TOML table in `.meta.toml`, set the value for the key `test_runner` to `pytest` if you want to use [`pytest`](https://pypi.org/project/pytest).
By default, it falls back to use [`zope.testrunner`]((https://pypi.org/project/zope.testrunner)).
Expand Down Expand Up @@ -500,11 +500,11 @@ test_deps_additional = """
"""
```

When using `plone/meta` outside of plone core packages
When using `plone.meta` outside of plone core packages
there might be extra version pins, or overrides over the official versions.
To specify a custom constraints file, use the `constraints_file` key.

Generating a custom constraints.txt is out of scope for `plone/meta` itself,
Generating a custom constraints.txt is out of scope for `plone.meta` itself,
there are plenty of tools that can do that though.

```toml
Expand Down
2 changes: 1 addition & 1 deletion shared-workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v3
- name: 'Deprecation warning'
run: |
echo "This GHA is deprecated, please re-run plone/meta on your repository"
echo "This GHA is deprecated, please re-run plone.meta on your repository"
echo "If you are still relying on this jobs, "
echo "please create an issue in https://github.com/plone/meta/issues/new"
exit 1
2 changes: 1 addition & 1 deletion src/plone/meta/config-package.py
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ def _validate_editorconfig(self, file_obj):

@property
def _commit_msg(self):
return self.args.commit_msg or 'Configuring with plone/meta'
return self.args.commit_msg or 'Configuring with plone.meta'

def commit_and_push(self, filenames):
if not self.args.commit:
Expand Down

0 comments on commit 627837d

Please sign in to comment.