-
Notifications
You must be signed in to change notification settings - Fork 3.8k
website: restore pom.xml #15113
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
Closed
Closed
website: restore pom.xml #15113
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| ~ Licensed to the Apache Software Foundation (ASF) under one | ||
| ~ or more contributor license agreements. See the NOTICE file | ||
| ~ distributed with this work for additional information | ||
| ~ regarding copyright ownership. The ASF licenses this file | ||
| ~ to you under the Apache License, Version 2.0 (the | ||
| ~ "License"); you may not use this file except in compliance | ||
| ~ with the License. You may obtain a copy of the License at | ||
| ~ | ||
| ~ http://www.apache.org/licenses/LICENSE-2.0 | ||
| ~ | ||
| ~ Unless required by applicable law or agreed to in writing, | ||
| ~ software distributed under the License is distributed on an | ||
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| ~ KIND, either express or implied. See the License for the | ||
| ~ specific language governing permissions and limitations | ||
| ~ under the License. | ||
| --> | ||
|
|
||
| <!--Generate build output (/docs/latest) that you can deploy locally with something like http-server | ||
| to look at changes. | ||
| The actual output used for deploying a staging or prod build is done in | ||
| `druid-website-src`, which is also where version | ||
| interpolation is done. | ||
| --> | ||
|
|
||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <artifactId>druid-website</artifactId> | ||
| <name>druid-website</name> | ||
| <description>Website for druid.apache.org</description> | ||
|
|
||
| <parent> | ||
| <groupId>org.apache.druid</groupId> | ||
| <artifactId>druid</artifactId> | ||
| <version>28.0.0-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <properties> | ||
| <node.version>v16.17.0</node.version> | ||
| <npm.version>8.15.0</npm.version> | ||
|
Comment on lines
+42
to
+43
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. are these the recommended docusaurus 2 versions?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. They don't have a recommended NPM version and the recommended node version is 16.14 or later |
||
| </properties> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>com.github.eirslett</groupId> | ||
| <artifactId>frontend-maven-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>install-node-and-npm</id> | ||
| <goals> | ||
| <goal>install-node-and-npm</goal> | ||
| </goals> | ||
| <configuration> | ||
| <nodeVersion>${node.version}</nodeVersion> | ||
| <npmVersion>${npm.version}</npmVersion> | ||
| <workingDirectory>${project.build.directory}</workingDirectory> | ||
| <installDirectory>${project.build.directory}</installDirectory> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>npm-install</id> | ||
| <goals> | ||
| <goal>npm</goal> | ||
| </goals> | ||
| <configuration> | ||
| <arguments>ci</arguments> | ||
| <installDirectory>${project.build.directory}</installDirectory> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>spellcheck</id> | ||
| <goals> | ||
| <goal>npm</goal> | ||
| </goals> | ||
| <phase>test</phase> | ||
| <configuration> | ||
| <arguments>run spellcheck</arguments> | ||
| <workingDirectory>${project.build.directory}</workingDirectory> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.codehaus.mojo</groupId> | ||
| <artifactId>exec-maven-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>npm-run-build</id> | ||
| <phase>compile</phase> | ||
| <goals> | ||
| <goal>exec</goal> | ||
| </goals> | ||
| <configuration> | ||
| <executable>npm</executable> | ||
| <arguments> | ||
| <argument>run</argument> | ||
| <argument>build</argument> | ||
| </arguments> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i guess this needs to be 29 snapshot now since #15121 has been merged
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this used for anything outside of building the website and interpolating the version variable used in the docs?? The variable interpolation got moved to
druid-website-srcalong with the rest of the stuff for a production build.If not, we can probably delete it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it needs to match the rest of the pom versions if we are keeping this file at all i think, https://github.com/apache/druid/blob/master/pom.xml#L2128 has a profile that refers to this file. It seems useful to me to have a pom for the website that can run basic npm build and test commands the same as we have for web-console if its going to live in the same repository as the rest of druid stuff. whether or not it needs to build the full website or not i suppose is a different matter, but i think at least it should be able to run npm build and run the spellcheck (so that it can be done independently of whatever node/npm versions exist on the developers machine globally)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for example https://github.com/apache/druid/blob/master/distribution/asf-release-process-guide.md#set-version-and-make-a-tag still refers to bumping the website version so it matches everything else. it does look like maybe this part has been updated at least https://github.com/apache/druid/blob/master/distribution/asf-release-process-guide.md#update-druidstagedapacheorg, having not built the full website i'm not sure if it would ever make sense to try to drive that process through here instead of having to drive from the website-src repo...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, thanks for taking the time to explain it! I'm pretty unfamiliar with Maven since it's not really in the typical docs workflow.
I haven't had time to figure out why the spellchecker doesn't run when I do something like
mvn compilethough or if it runs, it doesn't return any feedback. Manually running it returns feedback on errors or success. The spellchecking script hasn't changed. The build runs and completes and we get feedback on it though