aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/tutorials/jenkins/JenkinsfileStep.tsx
blob: 576463cf71648a442ee04be2ed02bc2567f2f3ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * SonarQube
 * Copyright (C) 2009-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import * as React from 'react';
import { translate } from 'sonar-ui-common/helpers/l10n';
import { getBaseUrl } from 'sonar-ui-common/helpers/urls';
import { withAppState } from '../../hoc/withAppState';
import RenderOptions from '../components/RenderOptions';
import SentenceWithHighlights from '../components/SentenceWithHighlights';
import Step from '../components/Step';
import { BuildTools } from '../types';
import DotNet from './buildtool-steps/DotNet';
import Gradle from './buildtool-steps/Gradle';
import Maven from './buildtool-steps/Maven';
import Other from './buildtool-steps/Other';

export interface JenkinsfileStepProps {
  appState: T.AppState;
  component: T.Component;
  open: boolean;
}

// To remove when CFamily is includ in this tutorial
type BuildToolsWithoutCFamily = Exclude<BuildTools, BuildTools.CFamily>;

const BUILDTOOL_COMPONENT_MAP: {
  [x in BuildToolsWithoutCFamily]: React.ComponentType<{ component: T.Component }>;
} = {
  [BuildTools.Maven]: Maven,
  [BuildTools.Gradle]: Gradle,
  [BuildTools.DotNet]: DotNet,
  [BuildTools.Other]: Other
};

export function JenkinsfileStep(props: JenkinsfileStepProps) {
  const {
    appState: { branchesEnabled },
    component,
    open
  } = props;
  const [buildTool, setBuildTool] = React.useState<BuildToolsWithoutCFamily | undefined>(undefined);
  return (
    <Step
      finished={false}
      open={open}
      renderForm={() => (
        <div className="boxed-group-inner">
          <ol className="list-styled">
            <li>
              {translate('onboarding.build')}
              <RenderOptions
                checked={buildTool}
                name="buildtool"
                onCheck={value => setBuildTool(value as BuildToolsWithoutCFamily)}
                optionLabelKey="onboarding.build"
                options={Object.keys(BUILDTOOL_COMPONENT_MAP)}
              />
            </li>
            {buildTool !== undefined &&
              React.createElement(BUILDTOOL_COMPONENT_MAP[buildTool], { component })}
          </ol>
          {buildTool !== undefined && (
            <>
              <hr className="huge-spacer-top huge-spacer-bottom" />
              <div className="abs-width-600">
                <p className="big-spacer-bottom">
                  <SentenceWithHighlights
                    highlightKeys={['all_set']}
                    translationKey="onboarding.tutorial.with.jenkins.all_set"
                  />
                </p>
                <div className="display-flex-row big-spacer-bottom">
                  <div>
                    <img
                      alt="" // Should be ignored by screen readers
                      className="big-spacer-right"
                      width={30}
                      src={`${getBaseUrl()}/images/tutorials/commit.svg`}
                    />
                  </div>
                  <div>
                    <p className="little-spacer-bottom">
                      <strong>{translate('onboarding.tutorial.with.jenkins.commit')}</strong>
                    </p>
                    <p>
                      {branchesEnabled
                        ? translate('onboarding.tutorial.with.jenkins.commit.why')
                        : translate('onboarding.tutorial.with.jenkins.commit.why.no_branches')}
                    </p>
                  </div>
                </div>
                <div className="display-flex-row huge-spacer-bottom">
                  <div>
                    <img
                      alt="" // Should be ignored by screen readers
                      className="big-spacer-right"
                      width={30}
                      src={`${getBaseUrl()}/images/tutorials/refresh.svg`}
                    />
                  </div>
                  <div>
                    <p className="little-spacer-bottom">
                      <strong>{translate('onboarding.tutorial.with.jenkins.refresh')}</strong>
                    </p>
                    <p>{translate('onboarding.tutorial.with.jenkins.refresh.why')}</p>
                  </div>
                </div>
              </div>
            </>
          )}
        </div>
      )}
      stepNumber={3}
      stepTitle={translate('onboarding.tutorial.with.jenkins.jenkinsfile.title')}
    />
  );
}

export default withAppState(JenkinsfileStep);