1
0
mirror of https://github.com/PanJiaChen/vue-element-admin.git synced 2025-08-07 18:25:45 +08:00

add release Notes (#801)

* add release Notes

* fixed notes releases

Co-authored-by: elsiosanchez <elsiosanche@gmail.com>
This commit is contained in:
Elsio Sanchez 2021-05-04 14:39:25 -04:00 committed by GitHub
parent 1e90c13ebf
commit 4c46334171
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 486 additions and 103 deletions

View File

@ -20,10 +20,12 @@ import request from '@/utils/request'
import { config } from '@/utils/ADempiere/config'
const baseURL = config.documentation.api.url
// Fetch releases from repository
export function fetchReleasesList() {
export function fetchReleasesList({
repository
}) {
return request({
baseURL,
url: '/adempiere-vue/releases',
url: repository + '/releases',
method: 'get',
headers: {
'Accept': 'application/vnd.github.v3+json'

View File

@ -98,7 +98,12 @@ export default {
documentation: {
documentation: 'Documentation',
github: 'Github Repository',
releases: 'Releases'
releases: 'Releases',
branches: 'Branches',
code: 'Code',
issues: 'Issues',
downloadZip: 'Download Zip',
releaseNotes: 'Release Notes'
},
permission: {
addRole: 'New Role',

View File

@ -98,7 +98,13 @@ export default {
documentation: {
documentation: 'Documentación',
github: 'Repositorio Github',
releases: 'Liberaciones'
releases: 'Liberaciones',
branches: 'Ramas',
code: 'Código',
issues: 'Solicitudes de extracción',
downloadZip: 'descargar Zip',
releaseNotes: 'Nota de Liberaciones'
},
permission: {
addRole: 'Nuevo rol',

View File

@ -13,6 +13,7 @@ import tableRouter from './modules/table'
import nestedRouter from './modules/nested'
import enrollmentRoute from './modules/ADempiere/enrollment.js'
import language from '@/lang'
/**
* Note: sub-menu only appear when route children.length >= 1
@ -97,7 +98,7 @@ export const constantRoutes = [
path: 'index',
component: () => import('@/views/documentation/index'),
name: 'Documentation',
meta: { title: 'documentation', icon: 'documentation', affix: true, isIndex: true }
meta: { title: language.t('documentation.releaseNotes'), icon: 'documentation', affix: true, isIndex: true }
}
]
},

View File

@ -1,88 +1,332 @@
<template>
<div>
<el-row>
<el-row :gutter="24">
<!-- ADempiere Vue -->
<el-col :span="defaultSize" :style="style">
<el-card class="box-card">
<div slot="header" class="clearfix">
<span>
<b> {{ $t('documentation.documentation') }} </b>
</span>
<a target="_blank" :href="readmeDocument.href">
<svg-icon icon-class="link" />
</a>
<div style="float: left;display: inline-flex;margin-top: 2%;">
<span>
<b> {{ RepositoryADVue.title }} </b>
</span>
<a target="_blank" :href="RepositoryADVue.href" style="margin-left: 5px;">
<svg-icon icon-class="link" />
</a>
</div>
<div style="float: right;display: inline-flex;">
<el-popover
placement="right"
width="350"
trigger="click"
style="float: right"
>
<el-tabs v-model="activeName">
<el-tab-pane label="HTTPS" name="HTTPS">
<div style="display: flex;">
<el-input
v-model="RepositoryADVue.clone"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.clone)" />
</div>
</el-tab-pane>
<el-tab-pane label="SSH" name="SSH">
<div style="display: flex;">
<el-input
v-model="RepositoryADVue.sshUrl"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.sshUrl)" />
</div>
</el-tab-pane>
</el-tabs>
<el-button plain style="width: -webkit-fill-available;">
<a target="_blank" :href="RepositoryADVue.downloadZip">
<svg-icon icon-class="zip" /> {{ $t('documentation.downloadZip') }}
</a>
</el-button>
<el-button slot="reference" icon="el-icon-download" type="success" size="mini" plain>
{{ $t('documentation.code') }}
</el-button>
</el-popover>
<el-button type="primary" size="mini" plain style="margin: 0px;padding-right: 3px;">
<a target="_blank" :href="RepositoryADVue.href + '/branches'">
<svg-icon icon-class="tree-table" /> {{ $t('documentation.branches') }}
</a>
</el-button>
<el-button type="warning" size="mini" plain style="margin: 0px;padding-right: 3px;">
<a target="_blank" :href="RepositoryADVue.href + '/issues'">
<i class="el-icon-warning el-icon--right" /> {{ $t('documentation.issues') }}
</a>
</el-button>
</div>
</div>
<div v-if="!isEmptyValue(RepositoryADVue)" style="display: inline-flex;width: 100%;">
<img width="100" height="100" :src="RepositoryADVue.avatar" style="margin-left: 20%;">
<p style="font-size: 30px;padding-top: 1%;color: #008fd3;"> {{ RepositoryADVue.title }} </p>
</div>
<p align="center">
<tags />
</p>
<div v-if="!isEmptyValue(RepositoryADVue)" id="markdown" v-markdown="RepositoryADVue.description" />
<el-collapse accordion>
<el-collapse-item name="1">
<template slot="title" style="font-size: 16px;">
<span style="font-size: 16px;font-weight: revert;">
<b> {{ releasesLabel }} </b>
</span>
<a target="_blank" :href="RepositoryADVue.href + '/releases'" style="font-size: 16px;font-weight: revert;padding-left: 1%">
<svg-icon icon-class="link" />
</a>
</template>
<el-collapse
v-model="activeListReleases"
accordion
>
<el-collapse-item
v-for="(releases, key) in releasesListADVue"
:key="key"
:name="key"
>
<template slot="title">
<svg v-if="key !== stopper" class="octicon octicon-tag" viewBox="0 0 16 16" version="1.1" width="16" height="16" style="margin-right: 2%;">
<path fill-rule="evenodd" :d="icon" />
</svg>
<b>
{{
releases.title
}}
</b>
</template>
<el-button type="text" style="float: right;">
<a target="_blank" :href="releases.download">
{{ releases.titleDownload }} <i class="el-icon-download" />
</a>
</el-button>
<div v-if="!isEmptyValue(releases)" id="markdown" v-markdown="releases.body" />
</el-collapse-item>
</el-collapse>
</el-collapse-item>
</el-collapse>
</el-card>
</el-col>
<!-- ADempiere Proxy -->
<el-col :span="defaultSize" :style="style">
<el-card class="box-card">
<div slot="header" class="clearfix">
<div style="float: left;display: inline-flex;margin-top: 2%;">
<span>
<b> {{ RepositoryProxyApi.title }} </b>
</span>
<a target="_blank" :href="RepositoryProxyApi.href" style="margin-left: 5px;">
<svg-icon icon-class="link" />
</a>
</div>
<div style="float: right;display: inline-flex;">
<el-popover
placement="right"
width="350"
trigger="click"
style="float: right"
>
<el-tabs v-model="activeName">
<el-tab-pane label="HTTPS" name="HTTPS">
<div style="display: flex;">
<el-input
v-model="RepositoryProxyApi.clone"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.clone)" />
</div>
</el-tab-pane>
<el-tab-pane label="SSH" name="SSH">
<div style="display: flex;">
<el-input
v-model="RepositoryProxyApi.sshUrl"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.sshUrl)" />
</div>
</el-tab-pane>
</el-tabs>
<el-button plain style="width: -webkit-fill-available;">
<a target="_blank" :href="RepositoryProxyApi.downloadZip">
<svg-icon icon-class="zip" /> {{ $t('documentation.downloadZip') }}
</a>
</el-button>
<el-button slot="reference" icon="el-icon-download" type="success" size="mini" plain>{{ $t('documentation.code') }}</el-button>
</el-popover>
<el-button type="primary" size="mini" plain>
<a target="_blank" :href="RepositoryProxyApi.href + '/branches'">
<svg-icon icon-class="tree-table" /> {{ $t('documentation.branches') }}
</a>
</el-button>
<el-button type="warning" size="mini" plain style="margin: 0px;padding-right: 3px;">
<a target="_blank" :href="RepositoryProxyApi.href + '/issues'">
<i class="el-icon-warning el-icon--right" /> {{ $t('documentation.issues') }}
</a>
</el-button>
</div>
</div>
<div v-if="!isEmptyValue(RepositoryProxyApi)" style="display: inline-flex;width: 100%;">
<img width="100" height="100" :src="RepositoryProxyApi.avatar" style="margin-left: 20%;">
<p style="font-size: 30px;padding-top: 1%;color: #008fd3;"> {{ RepositoryProxyApi.title }} </p>
</div>
<p align="center">
<tags />
</p>
<div v-if="!isEmptyValue(RepositoryProxyApi)" id="markdown" v-markdown="RepositoryProxyApi.description" />
<el-collapse accordion>
<el-collapse-item name="1">
<template slot="title" style="font-size: 16px;">
<span style="font-size: 16px;font-weight: revert;">
<b> {{ releasesLabel }} </b>
</span>
<a target="_blank" :href="RepositoryProxyApi.href + '/releases'" style="font-size: 16px;font-weight: revert;padding-left: 1%">
<svg-icon icon-class="link" />
</a>
</template>
<el-collapse
v-model="activeListReleases"
accordion
>
<el-collapse-item
v-for="(releases, key) in releasesListProxyApi"
:key="key"
:name="key"
>
<template slot="title">
<svg v-if="key !== stopper" class="octicon octicon-tag" viewBox="0 0 16 16" version="1.1" width="16" height="16" style="margin-right: 2%;">
<path fill-rule="evenodd" :d="icon" />
</svg>
<b>
{{
releases.title
}}
</b>
</template>
<el-button type="text" style="float: right;">
<a target="_blank" :href="releases.download">
{{ releases.titleDownload }} <i class="el-icon-download" />
</a>
</el-button>
<div v-if="!isEmptyValue(releases)" id="markdown" v-markdown="releases.body" />
</el-collapse-item>
</el-collapse>
</el-collapse-item>
</el-collapse>
</el-card>
</el-col>
<!-- ADempiere gRPC -->
<el-col :span="defaultSize" :style="style">
<el-card class="box-card">
<div slot="header" class="clearfix">
<div style="float: left;display: inline-flex;margin-top: 2%;">
<span>
<b> {{ RepositorygRPC.title }} </b>
</span>
<a target="_blank" :href="RepositorygRPC.href" style="margin-left: 5px;">
<svg-icon icon-class="link" />
</a>
</div>
<div style="float: right;display: inline-flex;">
<el-popover
placement="right"
width="350"
trigger="click"
style="float: right"
>
<el-tabs v-model="activeName">
<el-tab-pane label="HTTPS" name="HTTPS">
<div style="display: flex;">
<el-input
v-model="RepositorygRPC.clone"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.clone)" />
</div>
</el-tab-pane>
<el-tab-pane label="SSH" name="SSH">
<div style="display: flex;">
<el-input
v-model="RepositorygRPC.sshUrl"
:disabled="true"
/>
<el-button icon="el-icon-copy-document" @click="fallbackCopyTextToClipboard(RepositoryProxyApi.sshUrl)" />
</div>
</el-tab-pane>
</el-tabs>
<el-button plain style="width: -webkit-fill-available;">
<a target="_blank" :href="RepositorygRPC.downloadZip" style="width: -webkit-fill-available; display: table;">
<svg-icon icon-class="zip" /> {{ $t('documentation.downloadZip') }}
</a>
</el-button>
<el-button slot="reference" icon="el-icon-download" type="success" size="mini" plain>{{ $t('documentation.code') }}</el-button>
</el-popover>
<el-button type="primary" size="mini" plain>
<a target="_blank" :href="RepositorygRPC.href + '/branches'">
<svg-icon icon-class="tree-table" /> {{ $t('documentation.branches') }}
</a>
</el-button>
<el-button type="warning" size="mini" plain style="margin: 0px;padding-right: 3px;">
<a target="_blank" :href="RepositorygRPC.href + '/issues'">
<i class="el-icon-warning el-icon--right" /> {{ $t('documentation.issues') }}
</a>
</el-button>
</div>
</div>
<div>
<div v-if="!isEmptyValue(readmeDocument)" style="display: inline-flex;width: 100%;">
<img width="100" height="100" :src="readmeDocument.avatar" style="margin-left: 20%;">
<p style="font-size: 30px;padding-top: 1%;color: #008fd3;"> {{ readmeDocument.title }} </p>
<div v-if="!isEmptyValue(RepositorygRPC)" style="display: inline-flex;width: 100%;">
<img width="100" height="100" :src="RepositorygRPC.avatar" style="margin-left: 20%;">
<p style="font-size: 30px;padding-top: 1%;color: #008fd3;"> {{ RepositorygRPC.title }} </p>
</div>
<p align="center">
<tags />
</p>
<div v-if="!isEmptyValue(readmeDocument)" id="markdown" v-markdown="readmeDocument.description" />
<div v-if="!isEmptyValue(RepositorygRPC)" id="markdown" v-markdown="RepositorygRPC.description" />
<el-collapse accordion>
<el-collapse-item name="1">
<template slot="title" style="font-size: 16px;">
<span style="font-size: 16px;font-weight: revert;">
<b> {{ releasesLabel }} </b>
</span>
<a target="_blank" :href="RepositorygRPC.href + '/releases'" style="font-size: 16px;font-weight: revert;padding-left: 1%">
<svg-icon icon-class="link" />
</a>
</template>
<el-collapse
v-model="activeListReleases"
accordion
>
<el-collapse-item
v-for="(releases, key) in releasesListgRPC"
:key="key"
:name="key"
>
<template slot="title">
<svg v-if="key !== stopper" class="octicon octicon-tag" viewBox="0 0 16 16" version="1.1" width="16" height="16" style="margin-right: 2%;">
<path fill-rule="evenodd" :d="icon" />
</svg>
<b>
{{
releases.title
}}
</b>
</template>
<el-button type="text" style="float: right;">
<a target="_blank" :href="releases.download">
{{ releases.titleDownload }} <i class="el-icon-download" />
</a>
</el-button>
<div v-if="!isEmptyValue(releases.body)" id="markdown" v-markdown="releases.body" />
</el-collapse-item>
</el-collapse>
</el-collapse-item>
</el-collapse>
</div>
</el-card>
</el-col>
<el-col :span="defaultSize" :style="style">
<el-card class="box-card">
<div slot="header" class="clearfix">
<span>
<b> {{ $t('documentation.github') }} </b>
</span>
<a target="_blank" :href="readmeRepositoryGithub.href">
<svg-icon icon-class="link" />
</a>
</div>
<div v-if="!isEmptyValue(readmeRepositoryGithub)" style="display: inline-flex;width: 100%;">
<img width="100" height="100" :src="readmeRepositoryGithub.avatar" style="margin-left: 20%;">
<p style="font-size: 30px;padding-top: 1%;color: #008fd3;"> {{ readmeRepositoryGithub.title }} </p>
</div>
<p align="center">
<tags />
</p>
<div v-if="!isEmptyValue(readmeRepositoryGithub)" id="markdown" v-markdown="readmeRepositoryGithub.description" />
</el-card>
</el-col>
<el-col :span="defaultSize" :style="style">
<el-card class="box-card">
<div slot="header" class="clearfix">
<span>
<b> {{ releasesLabel }} </b>
</span>
<a target="_blank" :href="linkReleases">
<svg-icon icon-class="link" />
</a>
</div>
<el-collapse
v-model="activeListReleases"
accordion
>
<el-collapse-item
v-for="(releases, key) in releasesList"
:key="key"
:name="key"
>
<template slot="title">
<svg v-if="key !== stopper" class="octicon octicon-tag" viewBox="0 0 16 16" version="1.1" width="16" height="16" style="margin-right: 2%;">
<path fill-rule="evenodd" :d="icon" />
</svg>
<b>
{{
releases.title
}}
</b>
</template>
<el-button type="text" style="float: right;">
<a target="_blank" :href="releases.download">
{{ releases.titleDownload }} <i class="el-icon-download" />
</a>
</el-button>
<div v-if="!isEmptyValue(releases)" id="markdown" v-markdown="releases.body" />
</el-collapse-item>
</el-collapse>
</el-card>
</el-col>
</el-row>
</div>
</template>
@ -99,13 +343,20 @@ export default {
return {
releasesList: [],
activeNames: ['1'],
activeName: 'HTTPS',
icon: 'M2.5 7.775V2.75a.25.25 0 01.25-.25h5.025a.25.25 0 01.177.073l6.25 6.25a.25.25 0 010 .354l-5.025 5.025a.25.25 0 01-.354 0l-6.25-6.25a.25.25 0 01-.073-.177zm-1.5 0V2.75C1 1.784 1.784 1 2.75 1h5.025c.464 0 .91.184 1.238.513l6.25 6.25a1.75 1.75 0 010 2.474l-5.026 5.026a1.75 1.75 0 01-2.474 0l-6.25-6.25A1.75 1.75 0 011 7.775zM6 5a1 1 0 100 2 1 1 0 000-2z',
releaseNotes: {
body: ''
},
releasesLabel: this.$t('documentation.releases'),
readmeRepositoryGithub: {},
readmeDocument: {}
proxyDocument: {},
RepositoryADVue: {},
RepositoryProxyApi: {},
RepositorygRPC: {},
RepositoryADVueSite: {},
releasesListADVue: [],
releasesListProxyApi: [],
releasesListgRPC: []
}
},
computed: {
@ -122,52 +373,46 @@ export default {
return 'margin-top: 2%;padding: 0.5%;'
},
stopper() {
return this.releasesList.length - 1
return this.releasesListADVue.length - 1
},
activeListReleases() {
const active = this.releasesList.findIndex(releases => this.releaseNotes.title === releases.title)
const active = this.releasesListADVue.findIndex(releases => this.releaseNotes.title === releases.title)
return active
},
linkReleases() {
return this.readmeRepositoryGithub.href + '/releases'
return this.RepositoryADVue.href + '/releases'
}
},
created() {
this.loadReleasesList()
},
methods: {
fetchDocument() {
fetchReadme({
repository: 'adempiere-vue-site'
})
.then(response => {
this.readmeDocument = {
title: response.name,
href: response.html_url,
description: response.description,
avatar: response.organization.avatar_url
}
})
},
fetchRepository() {
// ADempiere Vue
fetchRepositoryADVue() {
fetchReadme({
repository: 'adempiere-vue'
})
.then(response => {
this.readmeRepositoryGithub = {
this.RepositoryADVue = {
title: response.name,
href: response.html_url,
description: response.description,
avatar: response.organization.avatar_url
avatar: response.organization.avatar_url,
clone: response.clone_url,
sshUrl: response.ssh_url,
branches: response.branches_url,
downloadZip: response.html_url + '/archive/refs/heads/' + response.default_branch + '.zip'
}
})
},
fechReleases() {
fetchReleasesList()
fetchReleasesList({
repository: '/adempiere-vue'
})
.then(response => {
if (response) {
response.forEach(release => {
this.releasesList.push({
this.releasesListADVue.push({
title: release.name,
href: release.html_url,
author: release.author.login,
@ -177,21 +422,145 @@ export default {
titleDownload: release.assets[0].name
})
})
if (config.repository.releaseNo !== undefined && this.releasesList.length > 0) {
this.releaseNotes = this.releasesList.find(release => {
if (config.repository.releaseNo !== undefined && this.releasesListADVue.length > 0) {
this.releaseNotes = this.releasesListADVue.find(release => {
return release.title === config.repository.releaseNo
})
if (!this.releaseNotes) {
this.releaseNotes = this.releasesList[0]
this.releaseNotes = this.releasesListADVue[0]
}
}
}
})
console.log(this.releasesListADVue)
},
// Proxy Adempiere Api
fetchRepositoryProxy() {
fetchReadme({
repository: 'proxy-adempiere-api'
})
.then(response => {
this.RepositoryProxyApi = {
title: response.name,
href: response.html_url,
description: response.description,
avatar: response.organization.avatar_url,
clone: response.clone_url,
sshUrl: response.ssh_url,
branches: response.branches_url,
downloadZip: response.html_url + '/archive/refs/heads/' + response.default_branch + '.zip'
}
})
},
fechReleasesProxy() {
fetchReleasesList({
repository: '/proxy-adempiere-api'
})
.then(response => {
if (response) {
response.forEach(release => {
this.releasesListProxyApi.push({
title: release.name,
href: release.html_url,
author: release.author.login,
body: release.body,
created_at: release.created_at,
download: this.isEmptyValue(release.assets) ? release.assets : release.assets[0].browser_download_url,
titleDownload: this.isEmptyValue(release.assets) ? release.assets : release.assets[0].name
})
})
if (config.repository.releaseNo !== undefined && this.releasesListProxyApi.length > 0) {
this.releaseNotes = this.releasesListProxyApi.find(release => {
return release.title === config.repository.releaseNo
})
if (!this.releaseNotes) {
this.releaseNotes = this.releasesListProxyApi[0]
}
}
}
})
},
// Adempiere gRPC Server
fetchRepositoryGRPC() {
fetchReadme({
repository: 'adempiere-gRPC-Server'
})
.then(response => {
this.RepositorygRPC = {
title: response.name,
href: response.html_url,
description: response.description,
avatar: response.organization.avatar_url,
clone: response.clone_url,
sshUrl: response.ssh_url,
branches: response.branches_url,
downloadZip: response.html_url + '/archive/refs/heads/' + response.default_branch + '.zip'
}
})
},
fechReleasesgRPC() {
fetchReleasesList({
repository: '/adempiere-gRPC-Server'
})
.then(response => {
if (response) {
response.forEach(release => {
this.releasesListgRPC.push({
title: this.isEmptyValue(release.name) ? release.tag_name : release.name,
href: release.html_url,
author: release.author.login,
body: release.body,
created_at: release.created_at,
download: release.assets[0].browser_download_url,
titleDownload: release.assets[0].name
})
})
if (config.repository.releaseNo !== undefined && this.releasesListgRPC.length > 0) {
this.releaseNotes = this.releasesListgRPC.find(release => {
return release.title === config.repository.releaseNo
})
if (!this.releaseNotes) {
this.releaseNotes = this.releasesListgRPC[0]
}
}
}
})
},
// load
loadReleasesList() {
this.fetchDocument()
this.fetchRepository()
// Repository
this.fetchRepositoryADVue()
this.fetchRepositoryProxy()
this.fetchRepositoryGRPC()
// Releases
this.fechReleases()
this.fechReleasesProxy()
this.fechReleasesgRPC()
},
// fallback Copy Text To Clip board
fallbackCopyTextToClipboard(text) {
const textArea = document.createElement('textarea')
textArea.value = text
document.body.appendChild(textArea)
textArea.focus()
textArea.select()
try {
if (document.execCommand('copy')) {
this.clipboardMessage(this.$t('notifications.copySuccessful'))
}
} catch (err) {
this.clipboardMessage(this.$t('notifications.copyUnsuccessful'))
}
document.body.removeChild(textArea)
},
// Notification Message when Copying TextNotification Message when Copying Text
clipboardMessage(message) {
this.$message({
message: message,
type: 'success',
showClose: true,
duration: 1500
})
}
}
}