This is an automated email from the ASF dual-hosted git repository. skygo pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/netbeans-antora-ui.git
The following commit(s) were added to refs/heads/main by this push: new e677d31 build preview removal new f13974d Merge pull request #8 from ebarboni/removepreview e677d31 is described below commit e677d3176d8ec4df4df94f5b28b81cf1091ac2c9 Author: Eric Barboni <sk...@apache.org> AuthorDate: Mon Oct 23 13:02:23 2023 +0200 build preview removal --- Jenkinsfile | 14 +++ LICENSE | 203 +++++++++++++++++++++++++++++++++++++++++++ build/netbeans-ui-bundle.zip | Bin 1685179 -> 1685179 bytes gulpfile.js | 162 +--------------------------------- preview-src/index.adoc | 33 ------- preview-src/page.adoc | 20 ----- preview-src/pagesynt.adoc | 20 ----- preview-src/ui-model.yml | 46 ---------- 8 files changed, 218 insertions(+), 280 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..b893325 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,14 @@ +pipeline { + agent { + label 'git-websites' + } + + stages { + stage('trigger-netbeans-site-build') { + + steps { + triggerRemoteJob remotePathMissing: [$class: 'StopAsFailure'], remotePathUrl: 'jenkins://712657a46c181b3ff60d2c029abcf8b7/Netbeans/netbeans-antora-organization/netbeans-antora/main' + } + } + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + diff --git a/build/netbeans-ui-bundle.zip b/build/netbeans-ui-bundle.zip index 6a35f57..77f2028 100644 Binary files a/build/netbeans-ui-bundle.zip and b/build/netbeans-ui-bundle.zip differ diff --git a/gulpfile.js b/gulpfile.js index f1b9b7a..ebc6324 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -7,32 +7,18 @@ const vfs = require('vinyl-fs') const zip = require('gulp-vinyl-zip') const merge = require('merge-stream') const rename = require('gulp-rename') -const fs = require('fs-extra') -const handlebars = require('handlebars') -const yaml = require('js-yaml') -const requireFromString = require('require-from-string') const srcDir = 'src' const previewDestDir = 'public' const destDir = `${previewDestDir}/_` -const previewSrcDir = 'preview-src' const buildDir = 'build' const path = require('path') -const ospath = require('path') -const { Transform } = require('stream') -const Asciidoctor = require('@asciidoctor/core')() -const map = (transform = () => {}, flush = undefined) => new Transform({ objectMode: true, transform, flush }) -const ASCIIDOC_ATTRIBUTES = { experimental: '', icons: 'font', sectanchors: '', 'source-highlighter': 'highlight.js' } + async function taskJSLint () { return src(['gulpfile.js']) .pipe(eslint()) .pipe(eslint.format()) } -/*async function taskJS2Lint () { - return src(['src/js/netbeans.js']) - .pipe(eslint()) - .pipe(eslint.format()) - }*/ async function scss () { const opts = { base: srcDir, cwd: srcDir } return vfs.src('scss/*.scss', opts) @@ -64,151 +50,6 @@ async function buildTask (cb) { bundle() } -function copyImages (src, dest) { - return vfs - .src('**/*.{png,svg}', { base: src, cwd: src }) - .pipe(vfs.dest(dest)) - .pipe(map((file, enc, next) => next())) -} - -function resolvePageURL (spec, context = {}) { - if (spec) { - return '/' + (spec = spec.split(':').pop()).slice(0, spec.lastIndexOf('.')) + '.html' - } -} - -function resolvePage (spec, context = {}) { - if (spec) { - return { pub: { url: resolvePageURL(spec) } } - } -} - -function loadSampleUiModel (src) { - return fs.readFile(ospath.join(src, 'ui-model.yml'), 'utf8').then((contents) => yaml.safeLoad(contents)) -} - -function transformHandlebarsError ({ message, stack }, layout) { - const m = stack.match(/^ *at Object\.ret \[as (.+?)\]/m) - const templatePath = `src/${m ? 'partials/' + m[1] : 'layouts/' + layout}.hbs` - const err = new Error(`${message}${~message.indexOf('\n') ? '\n^ ' : ' '}in UI template ${templatePath}`) - err.stack = [err.toString()].concat(stack.substr(message.length + 8)).join('\n') - return err -} - -function compileLayouts (src) { - const layouts = new Map() - return vfs.src('layouts/*.hbs', { base: src, cwd: src }).pipe( - map( - (file, enc, next) => { - const srcName = path.join(src, file.relative) - layouts.set(file.stem, handlebars.compile(file.contents.toString(), { preventIndent: true, srcName })) - next() - }, - function (done) { - this.push({ layouts }) - done() - } - ) - ) -} - -function registerPartials (src) { - return vfs.src('partials/*.hbs', { base: src, cwd: src }).pipe( - map((file, enc, next) => { - handlebars.registerPartial(file.stem, file.contents.toString()) - next() - }) - ) -} - -function registerHelpers (src) { - handlebars.registerHelper('resolvePage', resolvePage) - handlebars.registerHelper('resolvePageURL', resolvePageURL) - return vfs.src('helpers/*.js', { base: src, cwd: src }).pipe( - map((file, enc, next) => { - handlebars.registerHelper(file.stem, requireFromString(file.contents.toString())) - next() - }) - ) -} - -function toPromise (stream) { - return new Promise((resolve, reject, data = {}) => - stream - .on('error', reject) - .on('data', (chunk) => chunk.constructor === Object && Object.assign(data, chunk)) - .on('finish', () => resolve(data)) - ) -} - -async function previewTask (cb) { - buildTask() - return Promise.all([ - loadSampleUiModel(previewSrcDir), - toPromise( - merge(compileLayouts(srcDir), - registerPartials(srcDir), - registerHelpers(srcDir), - copyImages(previewSrcDir, previewSrcDir)) - ), - ]) - .then(([baseUiModel, { layouts }]) => { - const extensions = ((baseUiModel.asciidoc || { }).extensions || []).map((request) => { - ASCIIDOC_ATTRIBUTES[request.replace(/^@|\.js$/, '').replace(/[/]/g, '-') + '-loaded'] = '' - const extension = require(request) - extension.register.call(Asciidoctor.Extensions) - return extension - }) - const asciidoc = { extensions } - for (const component of baseUiModel.site.components) { - for (const version of component.versions || []) { - version.asciidoc = asciidoc - } - } - baseUiModel = { ...baseUiModel, env: process.env } - delete baseUiModel.asciidoc - return [baseUiModel, layouts] - }) - .then(([baseUiModel, layouts]) => - vfs - .src('**/*.adoc', { base: previewSrcDir, cwd: previewSrcDir }) - .pipe( - map((file, enc, next) => { - const siteRootPath = path.relative(ospath.dirname(file.path), ospath.resolve(previewSrcDir)) - const uiModel = { ...baseUiModel } - uiModel.page = { ...uiModel.page } - uiModel.siteRootPath = siteRootPath - uiModel.siteRootUrl = path.join(siteRootPath, 'index.html') - uiModel.uiRootPath = path.join(siteRootPath, '_') - if (file.stem === '404') { - uiModel.page = { layout: '404', title: 'Page Not Found' } - } else { - const doc = Asciidoctor.load(file.contents, { safe: 'safe', attributes: ASCIIDOC_ATTRIBUTES }) - uiModel.page.attributes = Object.entries(doc.getAttributes()) - .filter(([name, val]) => name.startsWith('page-')) - .reduce((accum, [name, val]) => { - accum[name.substr(5)] = val - return accum - }, { }) - uiModel.page.layout = doc.getAttribute('page-layout', 'default') - uiModel.page.title = doc.getDocumentTitle() - uiModel.page.contents = Buffer.from(doc.convert()) - } - file.extname = '.html' - - try { - file.contents = Buffer.from(layouts.get(uiModel.page.layout)(uiModel)) - next(null, file) - } catch (e) { - next(transformHandlebarsError(e, uiModel.page.layout)) - } - }) - ) - .pipe(vfs.dest(previewDestDir))) - // .on('error', (e) => done)) - //.pipe(sink()) -} - async function bundleTask (cb) { buildTask() vfs @@ -218,6 +59,5 @@ async function bundleTask (cb) { module.exports = { build: buildTask, - preview: previewTask, bundle: bundleTask, } diff --git a/preview-src/index.adoc b/preview-src/index.adoc deleted file mode 100644 index 37cf6af..0000000 --- a/preview-src/index.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Test Front Page -:page-layout: page_front - - - -[.cards] -**** - -// Add cards as you see fit below. Try not to repeat consecutive colors. - -[.card.blue] -.icon:edit[] Fast & Smart Editing -Apache NetBeans is much more than a text editor. It highlights source code xref:kb/docs/java/editor-codereference.adoc[syntactically and semantically], lets you easily xref:kb/docs/java/editor-inspect-transform.adoc[refactor code], with a range of handy and powerful tools. - -[.card.green] -.icon:wrench[] Java, JavaScript, PHP, HTML5, CSS, and More -Apache NetBeans provides editors, wizards, and templates to help you create applications in xref:kb/docs/java/index.adoc[Java], xref:kb/docs/php/index.adoc[PHP] and many other languages. - -[.card.magenta] -.icon:download[] Cross Platform -Apache NetBeans can be xref:download/index.adoc[installed] on all operating systems that support Java, i.e, Windows, Linux, Mac OSX and BSD. Write Once, Run Anywhere, applies to NetBeans too. - -[.card.green] -.icon:users[] Join us -Subscribe to our xref:community/mailing-lists.adoc[mailing lists], or follow us in link:https://twitter.com/netbeans[Twitter], link:https://tinyurl.com/netbeans-slack-signup/[Slack], link:https://www.facebook.com/NetBeans[FaceBook] or link:https://www.youtube.com/user/netbeansvideos[YouTube]. - -[.card.magenta] -.icon:arrow-right[] Participate -See how you can participate by xref:participate/submit-pr.adoc[submitting pull requests], xref:participate/report-issue.adoc[filing issues], or joining the link:https://cwiki.apache.org/confluence/display/NETBEANS/NetCAT[NetCAT] program. - -[.card.blue] -.icon:book[] Learn -We are currently reviewing the tutorials. See how you can xref:kb/docs/contributing.adoc[help us] review the xref:kb/docs/java/index.adoc[Java] and xref:kb/docs/php/index.adoc[PHP] tutorials. diff --git a/preview-src/page.adoc b/preview-src/page.adoc deleted file mode 100644 index 6255b3c..0000000 --- a/preview-src/page.adoc +++ /dev/null @@ -1,20 +0,0 @@ -= Welcome to Apache NetBeans -:page-layout: page - - -== Stay Informed - -The Apache NetBeans Community uses the xref:mailing-lists.adoc[mailing lists] as the primary source of communication. See how to stay informed and in touch with other NetBeans users and developers. - -== Participate -We welcome all kind of contributions. xref:../participate/index.adoc[See how you can participate in Apache NetBeans]. - -== NetBeans Events -NetBeans users and developers participate in different events. xref:events.adoc[See how this works]. - -== Who We Are -The Apache NetBeans source code was donated by Oracle to the link:https://www.apache.org[Apache Software Foundation] in 2016. -Since then many contributors have joined the project. Find out xref:who.adoc[who is who], and xref:committer.adoc[how to become a committer]. - -== NekoBean -xref:nekobean.adoc[NekoBean] is a mascot of Apache NetBeans Community. \ No newline at end of file diff --git a/preview-src/pagesynt.adoc b/preview-src/pagesynt.adoc deleted file mode 100644 index ff30462..0000000 --- a/preview-src/pagesynt.adoc +++ /dev/null @@ -1,20 +0,0 @@ -= Welcome to Apache NetBeans -:page-layout: page -:page-syntax: true - -== Stay Informed - -The Apache NetBeans Community uses the xref:mailing-lists.adoc[mailing lists] as the primary source of communication. See how to stay informed and in touch with other NetBeans users and developers. - -== Participate -We welcome all kind of contributions. xref:../participate/index.adoc[See how you can participate in Apache NetBeans]. - -== NetBeans Events -NetBeans users and developers participate in different events. xref:events.adoc[See how this works]. - -== Who We Are -The Apache NetBeans source code was donated by Oracle to the link:https://www.apache.org[Apache Software Foundation] in 2016. -Since then many contributors have joined the project. Find out xref:who.adoc[who is who], and xref:committer.adoc[how to become a committer]. - -== NekoBean -xref:nekobean.adoc[NekoBean] is a mascot of Apache NetBeans Community. \ No newline at end of file diff --git a/preview-src/ui-model.yml b/preview-src/ui-model.yml deleted file mode 100644 index 87ddb4e..0000000 --- a/preview-src/ui-model.yml +++ /dev/null @@ -1,46 +0,0 @@ -antoraVersion: '1.0.0' -site: - url: http://localhost:5252 - homeUrl: &home_url /xyz/5.2/index.html - components: - - name: abc - title: Project ABC - url: '#' - versions: - - &latest_version_abc - url: '#' - version: '1.1' - displayVersion: '1.1' - - url: '#' - version: '1.0' - displayVersion: '1.0' - latestVersion: *latest_version_abc - - &component - name: xyz - title: &component_title Project XYZ - url: /xyz/6.0/index.html - versions: - - &latest_version_xyz - url: /xyz/6.0/index.html - version: '6.0' - displayVersion: '6.0' - - &component_version - title: *component_title - url: '#' - version: '5.2' - displayVersion: '5.2' - - url: '#' - version: '5.1' - displayVersion: '5.1' - - url: '#' - version: '5.0' - displayVersion: '5.0' - latestVersion: *latest_version_xyz - -page: - url: *home_url - home: true - title: Brand’s Hardware & Software Requirements - component: *component - componentVersion: *component_version - --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@netbeans.apache.org For additional commands, e-mail: commits-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists