Skip to content

Fix URLs in generated readme.md #30710

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −35
Open

Fix URLs in generated readme.md #30710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion generators/angular/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ exports[`generator - angular:bootstrap bootstrapping default config should prepa
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
6 changes: 3 additions & 3 deletions generators/app/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
"postgresql",
],
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": [
"com.mycompany.myapp",
],
Expand Down Expand Up @@ -1135,7 +1135,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
"postgresql",
],
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": [
"com.mycompany.myapp",
],
Expand Down Expand Up @@ -1804,7 +1804,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
"postgresql",
],
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": [
"com.mycompany.myapp",
],
Expand Down
2 changes: 1 addition & 1 deletion generators/base-simple-application/__snapshots__/application.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
exports[`application mutation test expects mutateApplication to match snapshot 1`] = `
{
"customizeTemplatePaths": [],
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vjhipsterVersion",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"hipsterBugTrackerLink": "https://github.com/jhipster/generator-jhipster/issues?state=open",
"hipsterBugTrackerProductName": "JHipster",
"hipsterChatLink": "https://gitter.im/jhipster/generator-jhipster",
Expand Down
3 changes: 1 addition & 2 deletions generators/base-simple-application/application.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ export const mutateApplication = {
hipsterChatLink: 'https://gitter.im/jhipster/generator-jhipster',

projectDescription: ({ projectDescription, humanizedBaseName }) => projectDescription ?? `Description for ${humanizedBaseName}`,
documentationArchiveUrl: ({ jhipsterVersion, hipsterDocumentationLink }) =>
`${hipsterDocumentationLink}documentation-archive/v${jhipsterVersion}`,
documentationArchiveUrl: ({ hipsterDocumentationLink }) => `${hipsterDocumentationLink}`,

jhipsterPackageJson: packageJson,
} as const satisfies MutateDataPropertiesWithRequiredProperties<
Expand Down
2 changes: 1 addition & 1 deletion generators/ci-cd/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ exports[`generator - ci-cd cli with multiples values should match context snapsh
"dockerContainers": Any<Object>,
"dockerImage": undefined,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": [
"com.mycompany.myapp",
],
Expand Down
2 changes: 1 addition & 1 deletion generators/client/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ exports[`generator - client:bootstrap bootstrapping default config should prepar
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
16 changes: 8 additions & 8 deletions generators/common/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ plugins:
"README.md": {
"contents": "# jhipster

This application was generated using JHipster JHIPSTER_VERSION, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION](https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION).
This application was generated using JHipster JHIPSTER_VERSION, you can find documentation and help at [https://www.jhipster.tech/releases/](https://www.jhipster.tech/releases/).


## Project Structure
Expand All @@ -141,13 +141,13 @@ This application was generated using JHipster JHIPSTER_VERSION, you can find doc


[JHipster Homepage and latest documentation]: https://www.jhipster.tech/
[JHipster JHIPSTER_VERSION archive]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION
[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/development/
[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/docker-compose
[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/production/
[Running tests page]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/running-tests/
[Code quality page]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/code-quality/
[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION/setting-up-ci/
[JHipster releases]: https://www.jhipster.tech/releases/
[Using JHipster in development]: https://www.jhipster.tech/development/
[Using Docker and Docker-Compose]: https://www.jhipster.tech/docker-compose
[Using JHipster in production]: https://www.jhipster.tech/production/
[Running tests page]: https://www.jhipster.tech/running-tests/
[Code quality page]: https://www.jhipster.tech/code-quality/
[Setting up Continuous Integration]: https://www.jhipster.tech/setting-up-ci/

[Node.js]: https://nodejs.org/
[NPM]: https://www.npmjs.com/
Expand Down
2 changes: 1 addition & 1 deletion generators/common/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ exports[`generator - common:bootstrap bootstrapping default config should prepar
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
22 changes: 11 additions & 11 deletions generators/common/templates/README.md.jhi.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
_&>
# <%= baseName %>

This application was generated using JHipster <%= jhipsterVersion %>, you can find documentation and help at [<%= documentationArchiveUrl %>](<%= documentationArchiveUrl %>).
This application was generated using JHipster <%= jhipsterVersion %>, you can find documentation and help at [<%= documentationArchiveUrl %>releases/](<%= documentationArchiveUrl %>releases/).

<&- fragments.introSection() &>
## Project Structure
Expand All @@ -57,22 +57,22 @@ This application was generated using JHipster <%= jhipsterVersion %>, you can fi
<&- fragments.othersSection() &>
<& } &>
[JHipster Homepage and latest documentation]: <%= hipsterDocumentationLink %>
[JHipster <%= jhipsterVersion %> archive]: <%= documentationArchiveUrl %>
[JHipster releases]: <%= documentationArchiveUrl %>releases/
<%_ if (applicationTypeGateway || applicationTypeMicroservice) { _%>
[Doing microservices with JHipster]: <%= documentationArchiveUrl %>/microservices-architecture/
[Doing microservices with JHipster]: <%= documentationArchiveUrl %>microservices-architecture/
<%_ } _%>
[Using JHipster in development]: <%= documentationArchiveUrl %>/development/
[Using JHipster in development]: <%= documentationArchiveUrl %>development/
<%_ if (serviceDiscoveryEureka) { _%>
[Service Discovery and Configuration with the JHipster-Registry]: <%= documentationArchiveUrl %>/microservices-architecture/#jhipster-registry
[Service Discovery and Configuration with the JHipster-Registry]: <%= documentationArchiveUrl %>microservices-architecture/#jhipster-registry
<%_ } _%>
<%_ if (serviceDiscoveryConsul) { _%>
[Service Discovery and Configuration with Consul]: <%= documentationArchiveUrl %>/microservices-architecture/#consul
[Service Discovery and Configuration with Consul]: <%= documentationArchiveUrl %>microservices-architecture/#consul
<%_ } _%>
[Using Docker and Docker-Compose]: <%= documentationArchiveUrl %>/docker-compose
[Using JHipster in production]: <%= documentationArchiveUrl %>/production/
[Running tests page]: <%= documentationArchiveUrl %>/running-tests/
[Code quality page]: <%= documentationArchiveUrl %>/code-quality/
[Setting up Continuous Integration]: <%= documentationArchiveUrl %>/setting-up-ci/
[Using Docker and Docker-Compose]: <%= documentationArchiveUrl %>docker-compose
[Using JHipster in production]: <%= documentationArchiveUrl %>production/
[Running tests page]: <%= documentationArchiveUrl %>running-tests/
[Code quality page]: <%= documentationArchiveUrl %>code-quality/
[Setting up Continuous Integration]: <%= documentationArchiveUrl %>setting-up-ci/

[Node.js]: https://nodejs.org/
[NPM]: https://www.npmjs.com/
Expand Down
2 changes: 1 addition & 1 deletion generators/java/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ exports[`generator - java:bootstrap bootstrapping default config should prepare
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": Any<Array>,
"dtoSuffix": "DTO",
"dynamic": undefined,
Expand Down
2 changes: 1 addition & 1 deletion ...s/javascript-simple-application/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ exports[`generator - javascript-simple-application:bootstrap bootstrapping defau
"creationTimestamp": 1577836800000,
"customizeTemplatePaths": Any<Array>,
"dasherizedBaseName": "jhipster",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"eslintConfigFile": "eslint.config.mjs",
"hipster": "jhipster_family_member_3",
"hipsterBugTrackerLink": "https://github.com/jhipster/generator-jhipster/issues?state=open",
Expand Down
2 changes: 1 addition & 1 deletion generators/react/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ exports[`generator - react:bootstrap bootstrapping default config should prepare
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
2 changes: 1 addition & 1 deletion generators/server/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ exports[`generator - server:bootstrap bootstrapping default config should prepar
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
2 changes: 1 addition & 1 deletion generators/spring-boot/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ exports[`generator - spring-boot:bootstrap bootstrapping default config should p
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"domains": Any<Array>,
"dtoSuffix": "DTO",
"dynamic": undefined,
Expand Down
2 changes: 1 addition & 1 deletion generators/vue/generators/bootstrap/__snapshots__/generator.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ exports[`generator - vue:bootstrap bootstrapping default config should prepare a
"devServerPortProxy": 9000,
"dockerContainers": Any<Object>,
"dockerServicesDir": "src/main/docker/",
"documentationArchiveUrl": "https://www.jhipster.tech/documentation-archive/vJHIPSTER_VERSION",
"documentationArchiveUrl": "https://www.jhipster.tech/",
"dtoSuffix": "DTO",
"dynamic": undefined,
"embeddableLaunchScript": undefined,
Expand Down
Loading