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

Auto Generate Release Notes for TGCloud4_25_01_A #89

Closed
wants to merge 2 commits into from
Closed
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
17 changes: 17 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
site:
title: "Cloud Doc Test"
start_page: "cloud4:overview:index.adoc"

content:
sources:
- url: .
branches: HEAD
start_paths: [modules/cloud4, modules/cloud]

output:
dir: ./build/site

ui:
bundle:
url: https://github.com/tigergraph/antora-ui/blob/main/build/ui-bundle.zip?raw=true
snapshot: true
38 changes: 38 additions & 0 deletions gulpfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
'use strict'

const connect = require('gulp-connect')
const fs = require('fs')
const generator = require('@antora/site-generator-default')
const { reload: livereload } = process.env.LIVERELOAD === 'true' ? require('gulp-connect') : {}
const { series, src, watch } = require('gulp')
const yaml = require('js-yaml')

const playbookFilename = 'antora-playbook.yml'
const playbook = yaml.load(fs.readFileSync(playbookFilename, 'utf8'))
const outputDir = (playbook.output || {}).dir || './build/site'
const serverConfig = { name: 'Preview Site', livereload, port: 5000, root: outputDir }
const antoraArgs = ['--playbook', playbookFilename]
const watchPatterns = playbook.content.sources.filter((source) => !source.url.includes(':')).reduce((accum, source) => {
accum.push(`${source.url}/${source.start_path ? source.start_path + '/' : ''}antora.yml`)
accum.push(`${source.url}/${source.start_path ? source.start_path + '/' : ''}**/*.adoc`)
return accum
}, [])

function generate (done) {
generator(antoraArgs, process.env)
.then(() => done())
.catch((err) => {
console.log(err)
done()
})
}

function serve (done) {
connect.server(serverConfig, function () {
this.server.on('close', done)
watch(watchPatterns, generate)
if (livereload) watch(this.root).on('change', (filepath) => src(filepath, { read: false }).pipe(livereload()))
})
}

module.exports = { serve, generate, default: series(generate, serve) }
21 changes: 21 additions & 0 deletions modules/cloud4/modules/overview/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ TigerGraph Cloud 4 beta is for personal or R&D use and not for production use.
Please see xref:cloud4:resources:terms_conditions.adoc[].
====

== Dec 2024
=== 2024-12-30
==== Workspace Enhancements

* xref:cloud4:workgroup-workspace:workspaces/schedule.adoc[Scheduled Workspace Expansion and Shrink]: Schedule workspace expansion and shrink operations to align with your usage patterns and optimize resource allocation.
* Support HA with Cross-Zone Resiliency: Ensure business continuity and minimize downtime with the introduction of cross-zone high availability support, allowing you to deploy and manage resilient graph database clusters across multiple availability zones for enhanced fault tolerance and disaster recovery capabilities.

==== Observability Enhancements

* xref:cloud4:workgroup-workspace:workspaces/settings.adoc#_alerts_[Alerting] System: Stay informed about critical events and performance anomalies through the new alerting system, enabling proactive management of your graph database workspaces.

==== Stability Enhancements

* Improved stability and performance.

==== Other Enhancements

* Bug fixes.



== Oct 2024
=== 2024-10-15

Expand Down
22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "cloud-docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "antora generate --fetch antora-playbook.yml",
"dev": "gulp",
"serve": "http-server build/site -c-1"
},
"author": "",
"license": "ISC",
"dependencies": {
"@antora/cli": "^3.1.1",
"@antora/site-generator-default": "^3.1.1",
"gulp": "^4.0.2",
"gulp-cli": "^2.3.0",
"gulp-connect": "^5.7.0",
"js-yaml": "^4.1.0"
}
}