Automatic publishing system and method based on git and confluence

Abstract

The invention relates to an automatic publishing system and method based on git and confluence, the automatic publishing system comprises a confluence platform and a used git warehouse, a Jira filter is integrated on the confluence platform, the automatic publishing system receives configuration parameters input by a user, automatically generates a published document or automatically modifies a code version number, and replaces a corresponding character string in the Jira filter in the confluence, so that the automatic publishing system can automatically publish the document or automatically modify the code version number. And the git warehouse is used for updating and storing the code of which the version number needs to be modified. The automatic publishing method comprises a document creating and publishing process and a code version number modification process, in the document creating and publishing process, a published document is automatically generated according to published document configuration parameters input by a user, and in the code version number modification process, the published document is automatically generated according to modification version number configuration parameters input by the user. And automatically updating and modifying the code version number after the published document is generated. Compared with the prior art, the method can automatically and independently process document and code release, simplify manual configuration and maintenance, and improve release efficiency and accuracy.

Description

Technical Field

[0001] The present invention relates to the technical field of automatic publishing management, and in particular to an automatic publishing system and method based on GIT and Confluence. Background Art

[0002] As the size of software development teams continues to expand, the demand for project management and document management is increasing. Especially in projects with frequent releases and iterations, there are often a large number of documents that need to be updated, such as release notes, change logs, system configuration requirements, test reports, etc. Traditionally, manual release methods are mainly used. The operation process requires developers to manually perform a series of steps to complete manual writing and document organization, which is time-consuming, labor-intensive, error-prone, and has high manual maintenance costs. In order to improve work efficiency, it is necessary to use technical means to achieve full-process automated management of content from creation to distribution.

[0003] However, most of the existing automated publishing tools can only handle code publishing, but ignore the synchronous update of documents. There is a lack of an automated publishing tool that can effectively combine code management and document management.

[0004] In addition, during the code release process, the component version number is a key identifier for tracking and identifying different versions of components. Through the version number, you can clearly understand the iteration history of the component and the content of each change, which is crucial for troubleshooting, repairing, and subsequent version iterations. However, the existing technology uses manual version modification, which has the risk of input errors and may cause version confusion or dependency errors. Summary of the invention

[0005] The purpose of the present invention is to overcome the defects of the above-mentioned prior art and provide an automatic publishing system and method based on git and confluence, which can automatically and independently process the publishing of documents and codes, simplify manual configuration and maintenance, and improve publishing efficiency and accuracy.

[0006] The objective of the present invention can be achieved through the following technical scheme: an automated publishing system based on git and confluence, comprising a confluence platform and a git repository used, wherein a Jira filter is integrated on the confluence platform, wherein the automated publishing system receives configuration parameters input by a user, automatically generates a publishing document or automatically modifies a code version number, and replaces a corresponding string in a Jira filter in confluence, wherein the git repository is used to update and store the code with the modified version number.

[0007] An automated publishing method based on git and confluence includes a document creation and publishing process and a code version number modification process. The document creation and publishing process automatically generates a publishing document according to a publishing document configuration parameter input by a user. The code version number modification process automatically updates and modifies the code version number after the publishing document is generated according to a modified version number configuration parameter input by a user.

[0008] Furthermore, the document creation and publishing process includes the following steps:

[0009] S1. Obtain the configuration parameters of the published document input by the user;

[0010] S2. Based on the configuration parameters of the publishing document, perform template query, string replacement, and page copy operations in sequence to generate a new publishing page.

[0011] Furthermore, the publishing document configuration parameters include a template page ID, an update string, a filter string, a parent page ID, and a copy switch value.

[0012] Furthermore, the template query operation in step S2 specifically queries and obtains the corresponding template page from confluence according to the template page ID.

[0013] Furthermore, the string replacement operation in step S2 specifically replaces the filter string in the queried template page with the update string, and replaces the Jira filter at the same time to obtain a newly created page.

[0014] Furthermore, the page copy operation in step S2 is specifically based on the copy switch value. If the copy switch value is 1, the corresponding parent page is queried from confluence according to the parent page ID, and then the newly created page is copied to the parent page. If the copy switch value is 0, the page copy operation is not performed.

[0015] Furthermore, the code version number modification process includes the following steps:

[0016] T1. Get the modified version number configuration parameter entered by the user;

[0017] T2. Based on the modified version number configuration parameters, perform version modification branch pull, front-end and back-end component version number modification, and merge request operations in sequence.

[0018] Furthermore, the modified version number configuration parameters include a foreground component, a background component, a git branch and a version number.

[0019] Furthermore, the specific process of step T2 is: read the version number of the current project, automatically pull the version modification branch, and then automatically modify the version number according to the rules, including modifying the version numbers of the backend components and the frontend components, and automatically submit and initiate a merge to the release branch.

[0020] Compared with the prior art, the present invention has the following advantages:

[0021] The present invention connects the confluence platform with the git repository, and integrates a Jira filter on the confluence platform. The automatic publishing system receives the configuration parameters input by the user, automatically generates a publishing document or automatically modifies the code version number, and replaces the corresponding string in the Jira filter in confluence, and uses the git repository to update and store the code with the modified version number. In this way, the release of code and documents can be automatically and independently processed, the configuration and maintenance are simplified, and the overall release efficiency is improved.

[0022] The present invention proposes an automated publishing method based on git and confluence, including a document creation and publishing process and a code version number modification process, wherein the document creation and publishing process automatically generates a publishing document according to the publishing document configuration parameters input by the user, and the code version number modification process automatically updates and modifies the code version number after the publishing document is generated according to the modified version number configuration parameters input by the user. In this way, documents can be automatically created and modified, version numbers can be automatically updated and pushed to the git repository, the threshold for version release is lowered, work efficiency and accuracy are improved, and it is ensured that changes in version numbers can be performed synchronously and remain consistent. BRIEF DESCRIPTION OF THE DRAWINGS

[0023] Figure 1 It is a schematic diagram of the system structure of the present invention;

[0024] Figure 2 It is a schematic diagram of the method flow of the present invention;

[0025] Figure 3 is a schematic diagram of the application process of the embodiment;

[0026] Explanation of the marks in the figure: 1. Confluence platform, 2. Git repository, 3. Jira filter. DETAILED DESCRIPTION

[0027] The present invention is described in detail below with reference to the accompanying drawings and specific embodiments.

[0028] Example

[0029] like Figure 1As shown, an automatic publishing system based on git and confluence includes a confluence platform and a git repository 2 used therein. A Jira filter 3 is integrated on the confluence platform 1. The automatic publishing system receives configuration parameters input by the user, automatically generates a publishing document or automatically modifies the code version number, and replaces the corresponding string in the Jira filter 3 in confluence. The git repository 2 is used to update and store the code with the modified version number.

[0030] To facilitate the understanding of this solution, the following technical terms are explained:

[0031] git: a distributed version control system for code version management and collaboration;

[0032] Confluence: An enterprise-level knowledge management platform for document writing, storage, and sharing;

[0033] Jira: A professional issue tracking management system that is mainly used to help teams manage and track the progress of their work, especially in the fields of software development and testing.

[0034] Apply the above system to implement an automated publishing method based on git and confluence, such as Figure 2 As shown, it includes a document creation and publishing process and a code version number modification process, wherein the document creation and publishing process automatically generates a publishing document according to the publishing document configuration parameters input by the user, and the code version number modification process automatically updates and modifies the code version number after the publishing document is generated according to the modified version number configuration parameters input by the user.

[0035] Specifically, the document creation and publishing process includes the following steps:

[0036] S1. Obtain the document publishing configuration parameters input by the user (including template page ID, update string, filter string, parent page ID, copy switch value);

[0037] S2. Based on the configuration parameters of the release document, perform template query, string replacement, and page copy operations in sequence to generate a new release page:

[0038] First, query the corresponding template page from confluence according to the template page ID;

[0039] Then replace the filter string in the queried template page with the update string, and replace the Jira filter at the same time to get the newly created page;

[0040] Then according to the copy switch value, if the copy switch value is 1, the corresponding parent page is queried from confluence according to the parent page ID, and then the newly created page is copied to the parent page. If the copy switch value is 0, the page copy operation is not performed.

[0041] The code version number modification process includes the following steps:

[0042] T1. Obtain the modified version number configuration parameters entered by the user (including front-end components, back-end components, git branches and version numbers);

[0043] T2. Based on the modified version number configuration parameters, perform version modification branch pull, front-end and back-end component version number modification, and merge request operations in sequence:

[0044] First, read the version number of the current project, automatically pull the version modification branch, and then automatically modify the version number according to the rules, including modifying the version numbers of the backend components and the frontend components, and automatically submit and initiate a merge to the release branch.

[0045] This embodiment adopts the above solution to build an automatic publishing system tool, and its application process is as follows: Figure 3 As shown, through shell scripts and command line interactive interfaces, users select systems and components, and enter the branch to be modified and the version number to be modified. The tool will decide whether to pull the project from gitlab based on whether the local repository contains the project. At the same time, it will automatically update the local repository code, automatically create temporary branches, automatically modify the version number, automatically create MR (Merge Request), and generate MR links. In this way, the version publisher only needs to click the MR link and merge the MR to complete the modification of the version number, which greatly saves the release time, improves the release efficiency, and reduces the probability of manual operation errors. In addition, the tool supports the expansion of systems and components, and new components can be seamlessly connected to the tool through configuration.

[0046] On the other hand, through Java applications, only simple configuration is required to fill in the name of this integration release, and then the release document containing all necessary information is automatically generated and the Jira filter in the document is automatically rewritten. These documents may include release notes, change logs, system configuration requirements, test reports, etc. Automatically generating documents reduces the time of manual writing and organizing documents, allowing developers to focus on the development and testing of core functions. Automation tools follow preset rules and logic, reducing errors caused by human factors. This function is suitable for software development projects of all sizes, especially in projects with frequent releases and iterations. It is more effective and can help teams quickly generate high-quality release documents and improve the transparency and traceability of project management.

[0047] In summary, this solution can automatically create and modify documents: Traditional development documents are usually created by manual maintenance, which has high labor costs and low creation efficiency. On the other hand, the learning cost is high. Therefore, this solution relies on ConfluenceAPI to automatically generate confluence pages based on the published document template, and at the same time modify the user to embed Jira filters in the Confluence page so that the published documents and versions correspond. Users can configure macro parameters to specify the Jira filters to be used, the fields to be displayed, the sorting method, etc., so as to dynamically display related Jira issues on the Confluence page.

[0048] This solution can automatically update the version number and push the git repository: automatically read the version number of the current project (such as package.json, pom.xml, etc.), then automatically modify the version number according to the rules, and update the corresponding configuration files. Integrate the version number modification script into the release process, automatically perform the version number update operation during the release phase, and use automated tools to manage version number changes to reduce errors and improve efficiency, and also ensure that version number changes can be synchronized and maintained consistent.

[0049] Applying this solution to actual software development and testing projects can provide technical empowerment for inefficient repetitive work, lower the threshold for version release, improve release efficiency and accuracy, and provide reliable technical support for the automation and intelligence of the entire release process.

Claims

1. An automated publishing system based on git and confluence, characterized in that: The invention comprises a confluence platform (1) and a git repository (2) used therein. The confluence platform (1) is integrated with a Jira filter (3). The automated publishing system receives configuration parameters input by a user, automatically generates a publishing document or automatically modifies a code version number, and replaces a corresponding character string in the Jira filter (3) in confluence. The git repository (2) is used to update and store the code of the required modified version number.

2. An automated publishing method based on git and confluence, characterized in that: It includes a document creation and publishing process and a code version number modification process. The document creation and publishing process automatically generates a publishing document according to the publishing document configuration parameters input by the user. The code version number modification process automatically updates and modifies the code version number after the publishing document is generated according to the modified version number configuration parameters input by the user.

3. According to the automatic publishing method based on git and confluence according to claim 2, it is characterized in that: The document creation and publishing process includes the following steps: S1. Obtain the configuration parameters of the published document input by the user; S2. Based on the configuration parameters of the publishing document, perform template query, string replacement, and page copy operations in sequence to generate a new publishing page.

4. According to claim 3, an automated publishing method based on git and confluence, characterized in that: The publishing document configuration parameters include template page ID, update string, filter string, parent page ID, and copy switch value.

5. According to claim 4, an automated publishing method based on git and confluence, characterized in that: The template query operation in step S2 specifically queries and obtains the corresponding template page from confluence according to the template page ID.

6. According to the automatic publishing method based on git and confluence according to claim 5, it is characterized in that: The string replacement operation in step S2 specifically replaces the filter string in the queried template page with the update string, and replaces the Jira filter at the same time to obtain a newly created page.

7. The automated publishing method based on git and confluence according to claim 6, characterized in that: The page copy operation in step S2 is specifically based on the copy switch value. If the copy switch value is 1, the corresponding parent page is queried from confluence according to the parent page ID, and then the newly created page is copied to the parent page. If the copy switch value is 0, the page copy operation is not performed.

8. The automated publishing method based on git and confluence according to claim 2, characterized in that: The code version number modification process includes the following steps: T1. Get the modified version number configuration parameter entered by the user; T2. Based on the modified version number configuration parameters, perform version modification branch pull, front-end and back-end component version number modification, and merge request operations in sequence.

9. The automated publishing method based on git and confluence according to claim 8, characterized in that: The modified version number configuration parameters include foreground components, background components, git branches and version numbers.

10. The automated publishing method based on git and confluence according to claim 9, characterized in that: The specific process of step T2 is: read the version number of the current project, automatically pull the version modification branch, and then automatically modify the version number according to the rules, including modifying the version numbers of the backend components and the frontend components, and initiate a merge to the release branch after automatic submission.

Images