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

#725: Migrate Recording Changes to Markdown #783

Merged
merged 1 commit into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 0 additions & 49 deletions src/site/apt/examples/recording-changes.apt

This file was deleted.

44 changes: 44 additions & 0 deletions src/site/markdown/examples/recording-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
title: Recording Changes
author: Mark Raynsford
date: 2020-06-27

<!---
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
https://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.
-->

# Recording Changes

Here's an example:

```sh
mvn versions:use-latest-releases -DchangeRecorderFormat=xml
```

Which writes a file to `target/versions-changes.xml` that looks something like:

```xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<updates xmlns="http://www.mojohaus.org/versions-maven-plugin/schema/updates/1.0">
<update artifactId="dummy-api"
groupId="localhost"
kind="useLatestReleases"
newVersion="3.0"
oldVersion="1.1.1-2"/>
</updates>
```

The contents of this file records the fact that `localhost:dummy-api:1.1.1-2`
was upgraded to `3.0`.