<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:19:41 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary add field=key&field=summary to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>FOLIO Jira</title>
    <link>https://folio-org.atlassian.net</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>1001.0.0-SNAPSHOT</version>
        <build-number>100246</build-number>
        <build-date>07-02-2024</build-date>
    </build-info>

<item>
            <title>[FOLIO-2303] documentation for setting up deployment of feature branches</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-2303</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5cd423bebc70090d6ce241b1&quot; class=&quot;user-hover&quot; rel=&quot;5cd423bebc70090d6ce241b1&quot; data-account-id=&quot;5cd423bebc70090d6ce241b1&quot; accountid=&quot;5cd423bebc70090d6ce241b1&quot; rel=&quot;noreferrer&quot;&gt;Ian Hardy&lt;/a&gt; will provide more details. &lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Document the setting in Jenkins file to enable the branch deployment.&lt;/li&gt;
	&lt;li&gt;Document how to refer to branch artefacts in the platform- PRs. (both for backend and for front-end)&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;The published document is at &lt;a href=&quot;https://dev.folio.org/guides/branch-preview-kubernetes/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://dev.folio.org/guides/branch-preview-kubernetes/&lt;/a&gt;&lt;/p&gt;</description>
                <environment></environment>
        <key id="81453">FOLIO-2303</key>
            <summary>documentation for setting up deployment of feature branches</summary>
                <type id="10002" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10322?size=medium">New Feature</type>
                                            <priority id="10001" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p2.svg">P2</priority>
                        <status id="6" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="green"/>
                                    <resolution id="10003">Done</resolution>
                                                        <assignee accountid="5cd423bebc70090d6ce241b1">Ian Hardy</assignee>
                                                                <reporter accountid="557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d">Jakub Skoczen</reporter>
                                    <labels>
                            <label>platform-backlog</label>
                    </labels>
                <created>Tue, 8 Oct 2019 13:32:40 +0000</created>
                <updated>Wed, 3 Jun 2020 16:40:12 +0000</updated>
                            <resolved>Fri, 18 Oct 2019 13:47:34 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>4</watches>
                                                                <comments>
                                                            <comment id="193743" author="5cd423bebc70090d6ce241b1" created="Wed, 16 Oct 2019 00:08:33 +0000"  >&lt;p&gt;Here&apos;s more or less the documentation on publishing backend preview artifacts. There&apos;s alittle re-wrting to be done yet on dev.folio.org to fit it in.&lt;/p&gt;
&lt;h3&gt;&lt;a name=&quot;Publishingbackendpreviewartifacts&quot;&gt;&lt;/a&gt;Publishing backend preview artifacts&lt;/h3&gt;
&lt;p&gt;It may be desirable to create preview build that includes changes to backend modules that have not been merged into master. To achieve this, open a pull request on the backend module or modules with the publishPreview variable set to true in the main config, and in the docker configuration. A Jenkinsfile for a typical backend module might look like this:&lt;/p&gt;

&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;buildMvn {
  publishModDescriptor = &apos;yes&apos;
  publishAPI = &apos;yes&apos;
  mvnDeploy = &apos;yes&apos;
  runLintRamlCop = &apos;yes&apos;
  publishPreview = &apos;yes&apos;

  doDocker = {
    buildJavaDocker {
      publishMaster = &apos;yes&apos;
      publishPreview = &apos;yes&apos;
      healthChk = &apos;yes&apos;
      healthChkCmd = &apos;curl -sS --fail -o /dev/null  http://localhost:8081/apidocs/ || exit 1&apos;
    }
  }
}
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;Making these changes will achieve the following:&lt;br/&gt;
If the docker build is successful, the image will be deployed temporarily to an internal docker registry at repository.folio.org. The image will be tagged with the version number, the pr number, and the build number. For example, mod-users-15.6.1-SNAPSHOT.11.2 where &#8220;15.6.1-SNAPSHOT&#8221; is the version, 11 is the PR number, and 2 is the build number.&lt;br/&gt;
A modified module descriptor will be posted to okapi-preview.ci.folio.org&lt;br/&gt;
The module will be deployed to the preview CI kubernetes namespace.&lt;/p&gt;

&lt;h3&gt;&lt;a name=&quot;Includingbackendpreviewartifactsinaplatform&quot;&gt;&lt;/a&gt;Including backend preview artifacts in a platform&lt;/h3&gt;
&lt;p&gt;Preview builds are driven by pull requests against platform-core or platform-complete. To include a preview artifact, update the okapi-install.json file and replace the id of the module you would like to preview with the preview version. The preview version is the module&#8217;s regular version number, with the pr and build numbers appended (mod-name-version.pr.build.) For example:&lt;/p&gt;
&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;...
{
  &quot;id&quot;: &quot;mod-users-SNAPSHOT-15.6.1&quot;,
  &quot;action&quot;: &quot;enable&quot;
},...
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;

&lt;p&gt;should be replaced with:&lt;/p&gt;
&lt;div class=&quot;preformatted panel&quot; style=&quot;border-width: 1px;&quot;&gt;&lt;div class=&quot;preformattedContent panelContent&quot;&gt;
&lt;pre&gt;...
{
  &quot;id&quot;: &quot;mod-users-SNAPSHOT-15.6.1.11.2&quot;,
  &quot;action&quot;: &quot;enable&quot;
},...
&lt;/pre&gt;
&lt;/div&gt;&lt;/div&gt;
&lt;p&gt;Bear in mind that the module descriptor for this preview artifact is not published to the folio-registry, and is only available on okapi-preview.ci.folio.org.&lt;/p&gt;</comment>
                                                            <comment id="193745" author="557058:b8e64633-1f7c-402d-9caf-9959a5ba5d0d" created="Wed, 16 Oct 2019 13:08:35 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5cd423bebc70090d6ce241b1&quot; class=&quot;user-hover&quot; rel=&quot;5cd423bebc70090d6ce241b1&quot; data-account-id=&quot;5cd423bebc70090d6ce241b1&quot; accountid=&quot;5cd423bebc70090d6ce241b1&quot; rel=&quot;noreferrer&quot;&gt;Ian Hardy&lt;/a&gt; &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; Looks pretty good! To complete it we should also extend it with a section explaining how to add NPM branch &quot;artefacts&quot; to the platform-core (and to individual UI modules). I think John mentioned that the approach here is to point to the specific Git branch directly in the &lt;tt&gt;package.json&lt;/tt&gt; and omit using the Nexus NPM repository altogether. Is that the recommended approach? Do we need to confirm with the UI developers (e.g &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=615afd1cd9820f0070a09ef0&quot; class=&quot;user-hover&quot; rel=&quot;615afd1cd9820f0070a09ef0&quot; data-account-id=&quot;615afd1cd9820f0070a09ef0&quot; accountid=&quot;615afd1cd9820f0070a09ef0&quot; rel=&quot;noreferrer&quot;&gt;Zak Burke&lt;/a&gt;?). If so, &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5f9abc1eb45b2e007453f423&quot; class=&quot;user-hover&quot; rel=&quot;5f9abc1eb45b2e007453f423&quot; data-account-id=&quot;5f9abc1eb45b2e007453f423&quot; accountid=&quot;5f9abc1eb45b2e007453f423&quot; rel=&quot;noreferrer&quot;&gt;John Malconian&lt;/a&gt; will you contribute this section or can &lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5cd423bebc70090d6ce241b1&quot; class=&quot;user-hover&quot; rel=&quot;5cd423bebc70090d6ce241b1&quot; data-account-id=&quot;5cd423bebc70090d6ce241b1&quot; accountid=&quot;5cd423bebc70090d6ce241b1&quot; rel=&quot;noreferrer&quot;&gt;Ian Hardy&lt;/a&gt; handle it?&lt;/p&gt;</comment>
                                                            <comment id="193748" author="615afd1cd9820f0070a09ef0" created="Thu, 17 Oct 2019 10:42:44 +0000"  >&lt;p&gt;For UI modules, pointing directly to a GitHub branch of the module in the platform&apos;s &lt;tt&gt;package.json&lt;/tt&gt; file sounds like the right approach to me. &lt;/p&gt;</comment>
                                                            <comment id="193750" author="5cd423bebc70090d6ce241b1" created="Fri, 18 Oct 2019 12:55:53 +0000"  >&lt;p&gt;Opened a PR for dev.folio.org with draft documentation for creating a k8s preview. This will need to be reviewed for accuracy when pr preview is enabled. There are notes on what is needed in the PR: &lt;a href=&quot;https://github.com/folio-org/folio-org.github.io/pull/478&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/folio-org/folio-org.github.io/pull/478&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;The generated document associated with that PR is available &lt;a href=&quot;http://ssbp-devdoc-prodbranch-folio-2303-update-preview.dev.folio.org.s3-website-us-east-1.amazonaws.com/guides/branch-preview-kubernetes/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;here&lt;/a&gt;.&lt;/p&gt;</comment>
                                                            <comment id="193752" author="61cd0ca0bce5e00069e98be7" created="Wed, 29 Jan 2020 23:53:05 +0000"  >&lt;p&gt;Re-opened this because the documentation is not yet finalised.&lt;/p&gt;

&lt;p&gt;There are some notes above to be incorporated, and notes on the PR. There are some notes in private Slack. There might also be related notes arising from 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2401&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2401&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Create a demonstration for &amp;#39;PR Preview&amp;#39; &quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-2401
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="81607">FOLIO-2401</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10000" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarycf">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10057" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Development Team</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10144"><![CDATA[Core: Platform]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|i008sv:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1857">CP: sprint 74</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10044" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10024" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>[CHART] Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 16 Oct 2019 00:08:33 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10025" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>[CHART] Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>