From 056f00e831473adad0b4c8262107d2c3fc2ccca6 Mon Sep 17 00:00:00 2001 From: Tara Drwenski Date: Tue, 23 Jan 2024 09:29:02 -0700 Subject: [PATCH 1/3] Add version-info.json to repo and add gradle task to deploy to nexus --- gradle/root/publishing.gradle | 19 ++++++++++++++++++ project-files/docs/version-info.json | 30 ++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 project-files/docs/version-info.json diff --git a/gradle/root/publishing.gradle b/gradle/root/publishing.gradle index d49f107f2c..e38dfe2744 100644 --- a/gradle/root/publishing.gradle +++ b/gradle/root/publishing.gradle @@ -132,6 +132,25 @@ def publishReleaseInfoAndLatestTask = tasks.register('publishReleaseInfoAndLates publish.dependsOn publishReleaseInfoAndLatestTask +def publishVersionInfoTask = tasks.register('publishVersionInfo', PublishToRawRepoTask) { + group = 'publishing' + description = 'Publish version-info.json to Nexus docs.' + host = 'https://artifacts.unidata.ucar.edu/' + repoName = 'docs-tds' + + publishSrc = new File(rootProject.getProjectDir(), "project-files/docs/") + + onlyIf { + // Will be evaluated at task execution time, not during configuration. + // Fails the build if the specified properties haven't been provided. + username = getPropertyOrFailBuild NEXUS_USERNAME_KEY + password = getPropertyOrFailBuild NEXUS_PASSWORD_KEY + return true + } +} + +publish.dependsOn publishVersionInfoTask + // The "publish" tasks require credentials for our Nexus server, which they look for in Gradle properties. // If those properties (i.e. NEXUS_USERNAME_KEY and NEXUS_PASSWORD_KEY) haven't been provided, the build will fail. // Therefore, we only want to configure credentials when a "publish" task is part of the execution plan. Otherwise, diff --git a/project-files/docs/version-info.json b/project-files/docs/version-info.json new file mode 100644 index 0000000000..f90bd26f04 --- /dev/null +++ b/project-files/docs/version-info.json @@ -0,0 +1,30 @@ +{ + "package" : "tds", + "packageName" : "THREDDS Data Server", + "releases" : [ + { + "version": "5.4", + "include": "1", + "releaseDate": "2022-07-01", + "status": "release", + "docsets": { + "userguide": { + "baseUrl": "https://docs.unidata.ucar.edu/tds/5.4/userguide/index.html", + "docsetName": "TDS User's Guide" + } + } + }, + { + "version": "5.5", + "include": "1", + "releaseDate": "2024-01-23", + "status": "snapshot", + "docsets": { + "userguide": { + "baseUrl": "https://docs.unidata.ucar.edu/tds/5.5/userguide/index.html", + "docsetName": "TDS User's Guide" + } + } + } + ] +} From 97368c292f9227e83c2251e706bd7b7a5943014b Mon Sep 17 00:00:00 2001 From: Tara Drwenski Date: Tue, 23 Jan 2024 10:52:58 -0700 Subject: [PATCH 2/3] Update docs versions to 5.5 --- docs/adminguide/src/site/_data/sidebars/admin_sidebar.yml | 2 +- docs/devguide/src/site/_config.yml | 2 +- docs/devguide/src/site/_data/sidebars/dev_sidebar.yml | 2 +- docs/quickstart/src/site/_data/sidebars/quickstart_sidebar.yml | 2 +- docs/shared/src/site/_data/topnav.yml.golden | 2 +- docs/userguide/src/site/_config.yml | 2 +- docs/userguide/src/site/_data/sidebars/user_sidebar.yml | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/adminguide/src/site/_data/sidebars/admin_sidebar.yml b/docs/adminguide/src/site/_data/sidebars/admin_sidebar.yml index 0695a879ad..29385bf296 100644 --- a/docs/adminguide/src/site/_data/sidebars/admin_sidebar.yml +++ b/docs/adminguide/src/site/_data/sidebars/admin_sidebar.yml @@ -1,7 +1,7 @@ entries: - title: Sidebar product: Administrator's Guide - version: 5.4 + version: 5.5 folders: - title: output: pdf diff --git a/docs/devguide/src/site/_config.yml b/docs/devguide/src/site/_config.yml index 35832d6d6e..c8b6f293e8 100644 --- a/docs/devguide/src/site/_config.yml +++ b/docs/devguide/src/site/_config.yml @@ -2,7 +2,7 @@ theme: unidata-jekyll-theme # this will appear in an HTML meta tag, sidebar, and perhaps elsewhere -docset_version: 5.4 +docset_version: 5.5 # this appears on the top navigation bar next to the home button topnav_title: THREDDS Data Server (TDS) diff --git a/docs/devguide/src/site/_data/sidebars/dev_sidebar.yml b/docs/devguide/src/site/_data/sidebars/dev_sidebar.yml index 6a5a4aaea4..b96f3958b1 100644 --- a/docs/devguide/src/site/_data/sidebars/dev_sidebar.yml +++ b/docs/devguide/src/site/_data/sidebars/dev_sidebar.yml @@ -1,7 +1,7 @@ entries: - title: Sidebar product: TDS Developer's Guide - version: 5.4 + version: 5.5 folders: - title: diff --git a/docs/quickstart/src/site/_data/sidebars/quickstart_sidebar.yml b/docs/quickstart/src/site/_data/sidebars/quickstart_sidebar.yml index 0560628dc3..99ea4ee4b7 100644 --- a/docs/quickstart/src/site/_data/sidebars/quickstart_sidebar.yml +++ b/docs/quickstart/src/site/_data/sidebars/quickstart_sidebar.yml @@ -1,7 +1,7 @@ entries: - title: Sidebar product: TDS Tutorial And Reference Documentation - version: 5.4 + version: 5.5 folders: - title: diff --git a/docs/shared/src/site/_data/topnav.yml.golden b/docs/shared/src/site/_data/topnav.yml.golden index bc9eb25e9f..4d505f90f6 100644 --- a/docs/shared/src/site/_data/topnav.yml.golden +++ b/docs/shared/src/site/_data/topnav.yml.golden @@ -29,7 +29,7 @@ topnav_dropdowns: - title: GitHub external_url: https://github.com/Unidata/tds - title: Documentation - external_url: https://docs.unidata.ucar.edu/tds/5.4/userguide/index.html + external_url: https://docs.unidata.ucar.edu/tds/5.5/userguide/index.html - title: Rosetta folderitems: diff --git a/docs/userguide/src/site/_config.yml b/docs/userguide/src/site/_config.yml index 3c7fd2f426..93c54a43e9 100644 --- a/docs/userguide/src/site/_config.yml +++ b/docs/userguide/src/site/_config.yml @@ -2,7 +2,7 @@ theme: unidata-jekyll-theme # this will appear in an HTML meta tag, sidebar, and perhaps elsewhere -docset_version: 5.4 +docset_version: 5.5 # this appears on the top navigation bar next to the home button topnav_title: THREDDS Data Server (TDS) diff --git a/docs/userguide/src/site/_data/sidebars/user_sidebar.yml b/docs/userguide/src/site/_data/sidebars/user_sidebar.yml index 3d739dd33b..889dfa049a 100644 --- a/docs/userguide/src/site/_data/sidebars/user_sidebar.yml +++ b/docs/userguide/src/site/_data/sidebars/user_sidebar.yml @@ -1,7 +1,7 @@ entries: - title: Sidebar product: TDS User's Guide - version: 5.4 + version: 5.5 folders: - title: From 0caee5a61602ef1e3c230da7f9a06e0a3d87e094 Mon Sep 17 00:00:00 2001 From: Tara Drwenski Date: Tue, 23 Jan 2024 11:09:51 -0700 Subject: [PATCH 3/3] Use current in url instead of 5.5 --- docs/shared/src/site/_data/topnav.yml.golden | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shared/src/site/_data/topnav.yml.golden b/docs/shared/src/site/_data/topnav.yml.golden index 4d505f90f6..744aa3ccb6 100644 --- a/docs/shared/src/site/_data/topnav.yml.golden +++ b/docs/shared/src/site/_data/topnav.yml.golden @@ -29,7 +29,7 @@ topnav_dropdowns: - title: GitHub external_url: https://github.com/Unidata/tds - title: Documentation - external_url: https://docs.unidata.ucar.edu/tds/5.5/userguide/index.html + external_url: https://docs.unidata.ucar.edu/tds/current/userguide/index.html - title: Rosetta folderitems: