Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated CLI documentation with config file name #2602

Merged
merged 2 commits into from
Jul 10, 2023
Merged

Conversation

nathanczh
Copy link
Contributor

Thanks for contributing, make sure you address all the checklists (for details on how see development documentation)

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix
  • [] N/A added news fragment in docs/changelog folder
  • updated/extended the documentation

This PR is to resolve #1792 by adding the config file name to the CLI Interface page of the documentation. The intro paragraph of the config file section was modified to accommodate the change.

Copy link
Contributor

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaborbernat gaborbernat merged commit 55b2401 into pypa:main Jul 10, 2023
lengau referenced this pull request in canonical/charmcraft Jul 25, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [virtualenv](https://togithub.com/pypa/virtualenv) | `==20.23.1` ->
`==20.24.1` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/virtualenv/20.24.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/virtualenv/20.24.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/virtualenv/20.23.1/20.24.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/virtualenv/20.23.1/20.24.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>pypa/virtualenv (virtualenv)</summary>

###
[`v20.24.1`](https://togithub.com/pypa/virtualenv/releases/tag/20.24.1)

[Compare
Source](https://togithub.com/pypa/virtualenv/compare/20.24.0...20.24.1)

<!-- Release notes generated using configuration in .github/release.yml
at 20.24.1 -->

##### What's Changed

- release 20.24.0 by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/pypa/virtualenv/pull/2608](https://togithub.com/pypa/virtualenv/pull/2608)
- Upgrade `pip` by
[@&#8203;arielkirkwood](https://togithub.com/arielkirkwood) in
[https://github.com/pypa/virtualenv/pull/2611](https://togithub.com/pypa/virtualenv/pull/2611)

##### New Contributors

- [@&#8203;arielkirkwood](https://togithub.com/arielkirkwood) made their
first contribution in
[https://github.com/pypa/virtualenv/pull/2611](https://togithub.com/pypa/virtualenv/pull/2611)

**Full Changelog**:
pypa/virtualenv@20.24.0...20.24.1

###
[`v20.24.0`](https://togithub.com/pypa/virtualenv/releases/tag/20.24.0)

[Compare
Source](https://togithub.com/pypa/virtualenv/compare/20.23.1...20.24.0)

<!-- Release notes generated using configuration in .github/release.yml
at 20.24.0 -->

#### What's Changed

- release 20.23.1 by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/pypa/virtualenv/pull/2590](https://togithub.com/pypa/virtualenv/pull/2590)
- Fix the CI by [@&#8203;gaborbernat](https://togithub.com/gaborbernat)
in
[https://github.com/pypa/virtualenv/pull/2593](https://togithub.com/pypa/virtualenv/pull/2593)
- Quickstart guide by
[@&#8203;AlvesJorge](https://togithub.com/AlvesJorge) in
[https://github.com/pypa/virtualenv/pull/2599](https://togithub.com/pypa/virtualenv/pull/2599)
- Updated CLI documentation with config file name by
[@&#8203;nathanczh](https://togithub.com/nathanczh) in
[https://github.com/pypa/virtualenv/pull/2602](https://togithub.com/pypa/virtualenv/pull/2602)
- Exclude dependabot and pre-commit ci from release notes by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/pypa/virtualenv/pull/2603](https://togithub.com/pypa/virtualenv/pull/2603)
- Export `VIRTUAL_ENV_PROMPT` in activation scripts
([#&#8203;2194](https://togithub.com/pypa/virtualenv/issues/2194)) by
[@&#8203;jimporter](https://togithub.com/jimporter) in
[https://github.com/pypa/virtualenv/pull/2606](https://togithub.com/pypa/virtualenv/pull/2606)
- Upgrade setuptools by
[@&#8203;gaborbernat](https://togithub.com/gaborbernat) in
[https://github.com/pypa/virtualenv/pull/2607](https://togithub.com/pypa/virtualenv/pull/2607)

#### New Contributors

- [@&#8203;AlvesJorge](https://togithub.com/AlvesJorge) made their first
contribution in
[https://github.com/pypa/virtualenv/pull/2599](https://togithub.com/pypa/virtualenv/pull/2599)
- [@&#8203;nathanczh](https://togithub.com/nathanczh) made their first
contribution in
[https://github.com/pypa/virtualenv/pull/2602](https://togithub.com/pypa/virtualenv/pull/2602)
- [@&#8203;jimporter](https://togithub.com/jimporter) made their first
contribution in
[https://github.com/pypa/virtualenv/pull/2606](https://togithub.com/pypa/virtualenv/pull/2606)

**Full Changelog**:
pypa/virtualenv@20.23.1...20.24.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC,
Automerge - "before 07:00" in timezone Etc/UTC.

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/canonical/charmcraft).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi44LjExIiwidXBkYXRlZEluVmVyIjoiMzYuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the name of the config file
3 participants