Skip to content

Commit 61c4139

Browse files
wphillipmoorewphillipmoore-claude
andauthored
docs: rename mq-dev-environment references to mq-rest-admin-dev-environment (#325)
Update CI workflow, CLAUDE.md, shell scripts, developer-setup docs, and MQ container docs to use the new repository name, aligning with the mq-rest-admin-* naming convention. The historical CHANGELOG.md entry is left as-is. Ref mq-rest-admin-project/mq-rest-admin-dev-environment#14 Co-authored-by: wphillipmoore-claude <255925739+wphillipmoore-claude@users.noreply.github.com>
1 parent cb76506 commit 61c4139

9 files changed

Lines changed: 27 additions & 27 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ jobs:
263263
run: uv sync --frozen --group dev
264264

265265
- name: Setup MQ environment
266-
uses: wphillipmoore/mq-dev-environment/.github/actions/setup-mq@main
266+
uses: wphillipmoore/mq-rest-admin-dev-environment/.github/actions/setup-mq@main
267267
with:
268268
project-name: pymqrest
269269

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,13 @@ The `publish.yml` workflow triggers on push to `main` and publishes to PyPI via
140140
### Local MQ Container
141141

142142
The MQ development environment is owned by the
143-
[mq-dev-environment](https://github.com/wphillipmoore/mq-dev-environment)
143+
[mq-rest-admin-dev-environment](https://github.com/wphillipmoore/mq-rest-admin-dev-environment)
144144
repository. Clone it as a sibling directory before running lifecycle
145145
scripts:
146146

147147
```bash
148148
# Prerequisite (one-time)
149-
git clone https://github.com/wphillipmoore/mq-dev-environment.git ../mq-dev-environment
149+
git clone https://github.com/wphillipmoore/mq-rest-admin-dev-environment.git ../mq-rest-admin-dev-environment
150150

151151
# Start the containerized MQ queue managers
152152
./scripts/dev/mq_start.sh
@@ -165,7 +165,7 @@ git clone https://github.com/wphillipmoore/mq-dev-environment.git ../mq-dev-envi
165165
```
166166

167167
The lifecycle scripts are thin wrappers that delegate to
168-
`../mq-dev-environment`. Override the path with `MQ_DEV_ENV_PATH`.
168+
`../mq-rest-admin-dev-environment`. Override the path with `MQ_DEV_ENV_PATH`.
169169

170170
Container details:
171171
- Queue managers: `QM1` and `QM2`

docs/mq-container-local-dev.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ real command responses.
2121

2222
## Files
2323

24-
- `scripts/dev/mq_start.sh` — wrapper delegating to `mq-dev-environment`
25-
- `scripts/dev/mq_stop.sh` — wrapper delegating to `mq-dev-environment`
26-
- `scripts/dev/mq_reset.sh` — wrapper delegating to `mq-dev-environment`
27-
- `scripts/dev/mq_seed.sh` — wrapper delegating to `mq-dev-environment`
28-
- `scripts/dev/mq_verify.sh` — wrapper delegating to `mq-dev-environment`
24+
- `scripts/dev/mq_start.sh` — wrapper delegating to `mq-rest-admin-dev-environment`
25+
- `scripts/dev/mq_stop.sh` — wrapper delegating to `mq-rest-admin-dev-environment`
26+
- `scripts/dev/mq_reset.sh` — wrapper delegating to `mq-rest-admin-dev-environment`
27+
- `scripts/dev/mq_seed.sh` — wrapper delegating to `mq-rest-admin-dev-environment`
28+
- `scripts/dev/mq_verify.sh` — wrapper delegating to `mq-rest-admin-dev-environment`
2929

3030
Docker Compose, MQSC seed files, and web server configuration are owned
3131
by the
32-
[mq-dev-environment](https://github.com/wphillipmoore/mq-dev-environment)
32+
[mq-rest-admin-dev-environment](https://github.com/wphillipmoore/mq-rest-admin-dev-environment)
3333
repository.
3434

3535
## Prerequisites
3636

3737
- Docker Desktop or compatible Docker Engine.
3838
- IBM MQ container image access (license acceptance required).
39-
- The `mq-dev-environment` repository cloned as a sibling directory
40-
(`../mq-dev-environment`), or set `MQ_DEV_ENV_PATH` to its location.
39+
- The `mq-rest-admin-dev-environment` repository cloned as a sibling directory
40+
(`../mq-rest-admin-dev-environment`), or set `MQ_DEV_ENV_PATH` to its location.
4141

4242
## Configuration
4343

@@ -184,7 +184,7 @@ volume):
184184
- If the REST API is not reachable from the host, run:
185185

186186
```bash
187-
docker compose -f ../mq-dev-environment/config/docker-compose.yml exec -T qm1 \
187+
docker compose -f ../mq-rest-admin-dev-environment/config/docker-compose.yml exec -T qm1 \
188188
setmqweb properties -k httpHost -v "*"
189189
```
190190

docs/site/docs/development/developer-setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pymqrest depends on two sibling repositories:
2727
| --- | --- |
2828
| [pymqrest](https://github.com/wphillipmoore/mq-rest-admin-python) | This project |
2929
| [standards-and-conventions](https://github.com/wphillipmoore/standards-and-conventions) | Canonical project standards (referenced by `AGENTS.md` and git hooks) |
30-
| [mq-dev-environment](https://github.com/wphillipmoore/mq-dev-environment) | Dockerized MQ test infrastructure (local and CI) |
30+
| [mq-rest-admin-dev-environment](https://github.com/wphillipmoore/mq-rest-admin-dev-environment) | Dockerized MQ test infrastructure (local and CI) |
3131

3232
## Recommended directory layout
3333

@@ -37,14 +37,14 @@ Clone all three repositories as siblings:
3737
~/dev/
3838
├── mq-rest-admin-python/
3939
├── standards-and-conventions/
40-
└── mq-dev-environment/
40+
└── mq-rest-admin-dev-environment/
4141
```
4242

4343
```bash
4444
cd ~/dev
4545
git clone https://github.com/wphillipmoore/mq-rest-admin-python.git
4646
git clone https://github.com/wphillipmoore/standards-and-conventions.git
47-
git clone https://github.com/wphillipmoore/mq-dev-environment.git
47+
git clone https://github.com/wphillipmoore/mq-rest-admin-dev-environment.git
4848
```
4949

5050
## Initial setup
@@ -114,7 +114,7 @@ validation. The pipeline includes:
114114

115115
- **Unit tests** on Python 3.12, 3.13, and 3.14
116116
- **Integration tests** against real MQ queue managers via the shared
117-
`wphillipmoore/mq-dev-environment/.github/actions/setup-mq` action
117+
`wphillipmoore/mq-rest-admin-dev-environment/.github/actions/setup-mq` action
118118
- **Standards compliance** (ruff, mypy, ty, markdown lint, commit
119119
messages, repository profile)
120120
- **Dependency audit** (`pip-audit`)

scripts/dev/mq_reset.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
set -euo pipefail
33

44
repo_root="$(cd "$(dirname "$0")/../.." && pwd)"
5-
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-dev-environment}"
5+
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-rest-admin-dev-environment}"
66

77
if [ ! -d "$mq_dev_env" ]; then
8-
echo "mq-dev-environment not found at: $mq_dev_env" >&2
8+
echo "mq-rest-admin-dev-environment not found at: $mq_dev_env" >&2
99
echo "Clone it as a sibling directory or set MQ_DEV_ENV_PATH." >&2
1010
exit 1
1111
fi

scripts/dev/mq_seed.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
set -euo pipefail
33

44
repo_root="$(cd "$(dirname "$0")/../.." && pwd)"
5-
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-dev-environment}"
5+
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-rest-admin-dev-environment}"
66

77
if [ ! -d "$mq_dev_env" ]; then
8-
echo "mq-dev-environment not found at: $mq_dev_env" >&2
8+
echo "mq-rest-admin-dev-environment not found at: $mq_dev_env" >&2
99
echo "Clone it as a sibling directory or set MQ_DEV_ENV_PATH." >&2
1010
exit 1
1111
fi

scripts/dev/mq_start.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
set -euo pipefail
33

44
repo_root="$(cd "$(dirname "$0")/../.." && pwd)"
5-
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-dev-environment}"
5+
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-rest-admin-dev-environment}"
66

77
if [ ! -d "$mq_dev_env" ]; then
8-
echo "mq-dev-environment not found at: $mq_dev_env" >&2
8+
echo "mq-rest-admin-dev-environment not found at: $mq_dev_env" >&2
99
echo "Clone it as a sibling directory or set MQ_DEV_ENV_PATH." >&2
1010
exit 1
1111
fi

scripts/dev/mq_stop.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
set -euo pipefail
33

44
repo_root="$(cd "$(dirname "$0")/../.." && pwd)"
5-
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-dev-environment}"
5+
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-rest-admin-dev-environment}"
66

77
if [ ! -d "$mq_dev_env" ]; then
8-
echo "mq-dev-environment not found at: $mq_dev_env" >&2
8+
echo "mq-rest-admin-dev-environment not found at: $mq_dev_env" >&2
99
echo "Clone it as a sibling directory or set MQ_DEV_ENV_PATH." >&2
1010
exit 1
1111
fi

scripts/dev/mq_verify.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
set -euo pipefail
33

44
repo_root="$(cd "$(dirname "$0")/../.." && pwd)"
5-
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-dev-environment}"
5+
mq_dev_env="${MQ_DEV_ENV_PATH:-${repo_root}/../mq-rest-admin-dev-environment}"
66

77
if [ ! -d "$mq_dev_env" ]; then
8-
echo "mq-dev-environment not found at: $mq_dev_env" >&2
8+
echo "mq-rest-admin-dev-environment not found at: $mq_dev_env" >&2
99
echo "Clone it as a sibling directory or set MQ_DEV_ENV_PATH." >&2
1010
exit 1
1111
fi

0 commit comments

Comments
 (0)