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

GH-25271: Update Apache Description Of A Project (DOAP) File #408

Merged
merged 5 commits into from
Oct 3, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Sep 26, 2023

Rationale for this change

The Apache Community Development committee (ComDev) maintains a website projects.apache.org which lists all ASF projects, and some basic details about them. These details are derived from DOAP (Description Of A Project) file that is maintained by each PMC.

What changes are included in this PR?

Update the DOAP file for Arrow, which (in theory) drives the content of https://projects.apache.org/project.html?arrow, based on the output of the form at https://projects.apache.org/create.html.

I have already updated projects.xml as described on https://projects.apache.org/create.html. See apache/arrow#25271 (comment) for more details

Are these changes tested?

N/A

Are there any user-facing changes?

No

<revision>10.0.0</revision>
</Version>
</release>
<category rdf:resource="https://projects.apache.org/category/big-data" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

it seems as if arrow has grown significantly in scope since this file was first created.

Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

Thanks!

arrow.rdf Outdated
Comment on lines 49 to 55
<release>
<Version>
<name>Apache Arrow</name>
<created>2022-10-31</created>
<revision>10.0.0</revision>
</Version>
</release>
Copy link
Member

Choose a reason for hiding this comment

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

Can we keep <release>?
(The latest version is 13.0.0 at 2023-08-23: https://arrow.apache.org/release/ )

@alamb
Copy link
Contributor Author

alamb commented Sep 27, 2023

Can we keep ?
(The latest version is 13.0.0 at 2023-08-23: https://arrow.apache.org/release/ )

Given the DOAP page provides a link to https://arrow.apache.org/release/
Screenshot 2023-09-27 at 6 57 18 AM

My rationale in proposing to remove the specific version release link is that the value in avoiding a click through was not worth the the potential confusion if the link was stale (e.g. points at an old release)

If there is some straightforward / automated way to ensure it stays up to date, perhaps we can do that instead.

@kou
Copy link
Member

kou commented Sep 27, 2023

My rationale in proposing to remove the specific version release link is that the value in avoiding a click through was not worth the the potential confusion if the link was stale (e.g. points at an old release)

I understand.

If there is some straightforward / automated way to ensure it stays up to date, perhaps we can do that instead.

OK. How about the following?

diff --git a/_data/versions.yml b/_data/versions.yml
index 8273c1d1801..b68e9385490 100644
--- a/_data/versions.yml
+++ b/_data/versions.yml
@@ -19,7 +19,7 @@ current:
   number: '13.0.0'
   pinned_number: '13.0.*'
   major_number: '13'
-  date: '23 August 2023'
+  date: 2023-08-23
   git-tag: 'b7d2f7ffca66c868bd2fce5b3749c6caa002a7f0'
   github-tag-link: 'https://github.com/apache/arrow/releases/tag/apache-arrow-13.0.0'
   release-notes: 'https://arrow.apache.org/release/13.0.0.html'
diff --git a/arrow.rdf b/arrow.rdf
index fb2d6e79784..296ecae313f 100644
--- a/arrow.rdf
+++ b/arrow.rdf
@@ -1,3 +1,5 @@
+---
+---
 <?xml version="1.0"?>
 <?xml-stylesheet type="text/xsl"?>
 <rdf:RDF xml:lang="en"
@@ -49,8 +51,8 @@
     <release>
       <Version>
         <name>Apache Arrow</name>
-        <created>2022-10-31</created>
-        <revision>10.0.0</revision>
+        <created>{{ site.data.versions.current.date }}</created>
+        <revision>{{ site.data.versions.current.number }}</revision>
       </Version>
     </release>
     <repository>
  • We can refer https://github.com/apache/arrow-site/blob/main/_data/versions.yml data by {{ site.data.versions... }} by adding YAML front matter. (Empty YAML front matter is added in this case.)
  • We already have the current release information in the file.
  • The file is generated automatically in apache/arrow release process. [*] (I can fix date format later in apache/arrow.)

[*] https://github.com/apache/arrow/blob/aca1d3eeed3775c2f02e9f5d59d62478267950b1/dev/release/post-03-website.sh#L238-L272

@alamb
Copy link
Contributor Author

alamb commented Oct 2, 2023

Thanks @kou -- I have implemented your suggestion in 634e0ad I think.

@alamb
Copy link
Contributor Author

alamb commented Oct 2, 2023

I tested this locally by building the site (bundle exec rake ...) and then downloading http://localhost:4000/arrow.rdf. It seems to have worked great. Thank you @kou for sharing your Jekyll knowledge. 🙏

$ tail -n 15 ~/Downloads/arrow\ \(1\).rdf
    <release>
      <Version>
        <name>Apache Arrow</name>
        <created>2023-08-23</created>
        <revision>13.0.0</revision>
      </Version>
    </release>
    <repository>
      <GitRepository>
        <location rdf:resource="https://github.com/apache/arrow.git"/>
        <browse rdf:resource="https://github.com/apache/arrow/"/>
      </GitRepository>
    </repository>
  </Project>
</rdf:RDF>

kou added a commit to kou/arrow that referenced this pull request Oct 3, 2023
If we use ISO 8601 format for date value, we can use the value as a
`Date` object in Jekyll. It's easy to reuse.

Use case: apache/arrow-site#408
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

+1

Thanks!

I'll fix the release script in apache/arrow: apache/arrow#37984 / apache/arrow#37985

@kou kou merged commit 016d62f into apache:main Oct 3, 2023
@alamb alamb deleted the alamb/update_doap branch October 3, 2023 09:47
kou added a commit to apache/arrow that referenced this pull request Oct 3, 2023
### Rationale for this change

If we use ISO 8601 format for date value, we can use the value as a `Date` object in Jekyll. It's easy to reuse.

Use case: apache/arrow-site#408

### What changes are included in this PR?

Use ISO 8601 format.

### Are these changes tested?

No.

### Are there any user-facing changes?

No.
* Closes: #37984

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
…ache#37985)

### Rationale for this change

If we use ISO 8601 format for date value, we can use the value as a `Date` object in Jekyll. It's easy to reuse.

Use case: apache/arrow-site#408

### What changes are included in this PR?

Use ISO 8601 format.

### Are these changes tested?

No.

### Are there any user-facing changes?

No.
* Closes: apache#37984

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
…ache#37985)

### Rationale for this change

If we use ISO 8601 format for date value, we can use the value as a `Date` object in Jekyll. It's easy to reuse.

Use case: apache/arrow-site#408

### What changes are included in this PR?

Use ISO 8601 format.

### Are these changes tested?

No.

### Are there any user-facing changes?

No.
* Closes: apache#37984

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
…ache#37985)

### Rationale for this change

If we use ISO 8601 format for date value, we can use the value as a `Date` object in Jekyll. It's easy to reuse.

Use case: apache/arrow-site#408

### What changes are included in this PR?

Use ISO 8601 format.

### Are these changes tested?

No.

### Are there any user-facing changes?

No.
* Closes: apache#37984

Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
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.

[Website] Maintain and use DOAP file, or delete it
4 participants